src/include/access/valid.h

/*-------------------------------------------------------------------------
 *
 * valid.h
 *	  POSTGRES tuple qualification validity definitions.
 *
 *
 * Portions Copyright (c) 1996-2009, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * $PostgreSQL: pgsql/src/include/access/valid.h,v 1.41 2009/01/01 17:23:56 momjian Exp $
 *
 *-------------------------------------------------------------------------
 */
#ifndef VALID_H
#define VALID_H

/*
 *		HeapKeyTest
 *
 *		Test a heap tuple to see if it satisfies a scan key.
 */
static inline void
HeapKeyTest(HeapTuple tuple, TupleDesc tupdesc, int nkeys, ScanKey keys, bool * result) {
	/* Use underscores to protect the variables passed in as parameters */
	int __cur_nkeys = (nkeys);
	ScanKey __cur_keys = (keys);

	(*result) = true; /* may change */
	for (; __cur_nkeys--; __cur_keys++)
	{
		Datum __atp;
		bool __isnull;
		Datum __test;

		if (__cur_keys->sk_flags & SK_ISNULL)
		{
			(*result) = false;
			break;
		}

		__atp = heap_getattr((tuple), __cur_keys->sk_attno, (tupdesc),
				&__isnull);

		if (__isnull)
		{
			(*result) = false;
			break;
		}

		__test = FunctionCall2(&__cur_keys->sk_func, __atp,
				__cur_keys->sk_argument);

		if (!DatumGetBool(__test))
		{
			(*result) = false;
			break;
		}
	}
}

/*
 *		HeapKeyTestUsingSlot
 *
 *		Same as HeapKeyTest but pass a slot instead of a heap tuple.
 *		Eventually we may want to get rid of HeapKeyTest all together
 *		and instead only do the test through a slot, which should be
 *		faster.
 */
#define HeapKeyTestUsingSlot(slot, \
							 nkeys, \
							 keys, \
							 result) \
do \
{ \
	/* Use underscores to protect the variables passed in as parameters */ \
	int			__cur_nkeys = (nkeys); \
	ScanKey		__cur_keys = (keys); \
		\
	(result) = true; /* may change */ \
	for (; __cur_nkeys--; __cur_keys++) \
	{ \
		Datum	__atp; \
		bool	__isnull; \
		Datum	__test; \
\
		if (__cur_keys->sk_flags & SK_ISNULL) \
		{ \
			(result) = false; \
			break; \
		} \
\
		__atp = slot_getattr(slot, \
							 __cur_keys->sk_attno, \
							 &__isnull); \
\
		 if (__isnull) \
		 { \
			 (result) = false; \
				 break; \
		 } \
\
		 __test = FunctionCall2(&__cur_keys->sk_func, \
								__atp, __cur_keys->sk_argument); \
\
		if (!DatumGetBool(__test)) \
		{ \
			(result) = false; \
				break; \
		} \
	} \
} while (0)

#endif   /* VALID_H */