libs-base/Source/NSConcretePointerFunctions.h
Richard Frith-MacDonald e537692852 more gc fixups
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@28228 72102866-910b-0410-8b05-ffd578937521
2009-04-17 08:12:52 +00:00

150 lines
3.9 KiB
Objective-C

/**Interface for NSConcretePointerFunctions for GNUStep
Copyright (C) 2009 Free Software Foundation, Inc.
Written by: Richard Frith-Macdonald <rfm@gnu.org>
Date: 2009
This file is part of the GNUstep Base Library.
This library 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 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
Library 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 02111 USA.
*/
#import "Foundation/NSPointerFunctions.h"
/* Declare a structure type to copy pointer functions information
* around easily.
*/
typedef struct
{
void* (*acquireFunction)(const void *item,
NSUInteger (*size)(const void *item), BOOL shouldCopy);
NSString *(*descriptionFunction)(const void *item);
NSUInteger (*hashFunction)(const void *item,
NSUInteger (*size)(const void *item));
BOOL (*isEqualFunction)(const void *item1, const void *item2,
NSUInteger (*size)(const void *item));
void (*relinquishFunction)(const void *item,
NSUInteger (*size)(const void *item));
NSUInteger (*sizeFunction)(const void *item);
NSPointerFunctionsOptions options;
} PFInfo;
/* Declare the concrete pointer functions class as a wrapper around
* an instance of the PFInfo structure.
*/
@interface NSConcretePointerFunctions : NSPointerFunctions
{
@public
PFInfo _x;
}
@end
/* Wrapper functions to make use of the pointer functions.
*/
/* Acquire the pointer value to store for the specified item.
*/
static inline void
pointerFunctionsAcquire(PFInfo *PF, void **dst, void *src)
{
if (PF->acquireFunction != 0)
src = (*PF->acquireFunction)(src, PF->sizeFunction,
PF->options & NSPointerFunctionsCopyIn ? YES : NO);
#if GSWITHGC
if (PF->options & NSPointerFunctionsZeroingWeakMemory)
GSAssignZeroingWeakPointer(dst, src);
else
#endif
*dst = src;
}
/* Generate an NSString description of the item
*/
static inline NSString *
pointerFunctionsDescribe(PFInfo *PF, void *item)
{
if (PF->descriptionFunction != 0)
return (*PF->descriptionFunction)(item);
return nil;
}
/* Generate the hash of the item
*/
static inline NSUInteger
pointerFunctionsHash(PFInfo *PF, void *item)
{
if (PF->hashFunction != 0)
return (*PF->hashFunction)(item, PF->sizeFunction);
return (NSUInteger)(uintptr_t)item;
}
/* Compare two items for equality
*/
static inline BOOL
pointerFunctionsEqual(PFInfo *PF, void *item1, void *item2)
{
if (PF->isEqualFunction != 0)
return (*PF->isEqualFunction)(item1, item2, PF->sizeFunction);
if (item1 == item2)
return YES;
return NO;
}
/* Relinquish the specified item and set it to zero.
*/
static inline void
pointerFunctionsRelinquish(PFInfo *PF, void **itemptr)
{
if (PF->relinquishFunction != 0)
(*PF->relinquishFunction)(*itemptr, PF->sizeFunction);
if (PF->options & NSPointerFunctionsZeroingWeakMemory)
GSAssignZeroingWeakPointer(itemptr, (void*)0);
else
*itemptr = 0;
}
static inline void
pointerFunctionsReplace(PFInfo *PF, void **dst, void *src)
{
if (src != *dst)
{
if (PF->acquireFunction != 0)
src = (*PF->acquireFunction)(src, PF->sizeFunction,
PF->options & NSPointerFunctionsCopyIn ? YES : NO);
if (PF->relinquishFunction != 0)
(*PF->relinquishFunction)(*dst, PF->sizeFunction);
#if GSWITHGC
if (PF->options & NSPointerFunctionsZeroingWeakMemory)
GSAssignZeroingWeakPointer(dst, src);
else
#endif
*dst = src;
}
}