##########################################################################
#
#  Copyright (c) 2012, Image Engine Design Inc. All rights reserved.
#
#  Redistribution and use in source and binary forms, with or without
#  modification, are permitted provided that the following conditions are
#  met:
#
#      * Redistributions of source code must retain the above
#        copyright notice, this list of conditions and the following
#        disclaimer.
#
#      * Redistributions in binary form must reproduce the above
#        copyright notice, this list of conditions and the following
#        disclaimer in the documentation and/or other materials provided with
#        the distribution.
#
#      * Neither the name of John Haddon nor the names of
#        any other contributors to this software may be used to endorse or
#        promote products derived from this software without specific prior
#        written permission.
#
#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
#  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
#  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
#  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
#  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
#  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
#  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
#  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
#  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
#  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
#  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
##########################################################################

import IECore

import Gaffer

## A PathFilter which filters based on an item from Path.info() and an
# arbitrary match function.
## \deprecated Use MatchPatternPathFilter instead.
class InfoPathFilter( Gaffer.PathFilter ) :

	def __init__( self, infoKey, matcher, leafOnly=True, userData={} ) :

		Gaffer.PathFilter.__init__( self, userData )

		self.__infoKey = infoKey
		self.__matcher = matcher
		self.__leafOnly = leafOnly

	## Matcher and infoKey are set with one call, as otherwise
	# the intermediate state may yield a new matcher which doesn't work
	# with the old key.
	def setMatcher( self, infoKey, matcher ) :

		self.__infoKey = infoKey
		self.__matcher = matcher
		self.changedSignal()( self )

	def getMatcher( self ) :

		return self.__infoKey, self.__matcher

	def _filter( self, paths, canceller ) :

		if self.__matcher is None :
			return paths

		result = []
		for p in paths :
			if self.__leafOnly and not p.isLeaf() :
				result.append( p )
			else :
				i = p.info()
				if self.__infoKey in i :
					if self.__matcher( i[self.__infoKey] ) :
						result.append( p )

		return result

IECore.registerRunTimeTyped( InfoPathFilter, typeName = "Gaffer::InfoPathFilter" )
