mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-27 10:40:50 +00:00
673ede694e
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@27877 72102866-910b-0410-8b05-ffd578937521
139 lines
4.2 KiB
Objective-C
139 lines
4.2 KiB
Objective-C
/**Interface for NSPointerArray 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.
|
|
|
|
*/
|
|
|
|
#ifndef __NSPointerArray_h_GNUSTEP_BASE_INCLUDE
|
|
#define __NSPointerArray_h_GNUSTEP_BASE_INCLUDE
|
|
|
|
#import <Foundation/NSObject.h>
|
|
#import <Foundation/NSArray.h>
|
|
#import <Foundation/NSPointerFunctions.h>
|
|
|
|
#if OS_API_VERSION(100500, GS_API_LATEST)
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* An NSPointerArray acts like a standard mutable array except that it
|
|
* can contain nil and even non-object values.<br />
|
|
* The count can also be set causing the array to shrink (discarding items)
|
|
* or grow (adding nil/zero items).
|
|
*/
|
|
|
|
@interface NSPointerArray : NSObject <NSCopying, NSCoding>
|
|
|
|
/** Allocate an instance, initialise using initWithOptions: and
|
|
* return it autoreleased.
|
|
*/
|
|
+ (id) pointerArrayWithOptions: (NSPointerFunctionsOptions)options;
|
|
|
|
/** Allocate an instance, initialise using initWithPointerFunctions: and
|
|
* return it autoreleased.
|
|
*/
|
|
+ (id) pointerArrayWithPointerFunctions: (NSPointerFunctions *)functions;
|
|
|
|
/** Removes all nil/zero items from the array.
|
|
*/
|
|
- (void) compact; // eliminate NULLs
|
|
|
|
/** Returns the number of items in the array.
|
|
*/
|
|
- (NSUInteger) count;
|
|
|
|
/** Initialises the receiver with the spefieifd options.
|
|
*/
|
|
- (id) initWithOptions: (NSPointerFunctionsOptions)options;
|
|
|
|
/** Initialises the receiver using the supplied object.
|
|
*/
|
|
- (id) initWithPointerFunctions: (NSPointerFunctions*)functions;
|
|
|
|
/** Adds an item at the end of the array.
|
|
*/
|
|
- (void) addPointer: (void*)pointer;
|
|
|
|
/** Inserts an item at the specified index causing all higher indexed
|
|
* items to be adjusted upwards.<br />
|
|
* WARNING ... the Apple documented (and implemented in MacOS-X 10.5)
|
|
* behavior is to raise an exception if index is the same as the count of
|
|
* items in the array. This is insane ... for arrays, data and strings you
|
|
* can insert at the end of an object to append to it, so the behavior of
|
|
* this class in MacOS is inconsistent and must be considered buggy.
|
|
*/
|
|
- (void) insertPointer: (void*)pointer atIndex: (NSUInteger)index;
|
|
|
|
/** Returns the item at the given index or raises an exception if index
|
|
* is out of range.
|
|
*/
|
|
- (void*) pointerAtIndex: (NSUInteger)index;
|
|
|
|
/** Returns an autorelease NSPointerFunctions instance giving the
|
|
* functions in use by the receiver.
|
|
*/
|
|
- (NSPointerFunctions*) pointerFunctions;
|
|
|
|
/** Removes the item at the specified index, adjusting the positions of
|
|
* all higher indexed items.
|
|
*/
|
|
- (void) removePointerAtIndex: (NSUInteger)index;
|
|
|
|
/* Replaces the item at the specified index. The index must be less than
|
|
* the current count or an exception is raised.
|
|
*/
|
|
- (void) replacePointerAtIndex: (NSUInteger)index withPointer: (void*)item;
|
|
|
|
/** Sets the number of items in the receiver. Adds nil/zero items to pad
|
|
* the end of the array, or removes extraneous items from the end.
|
|
*/
|
|
- (void) setCount: (NSUInteger)count;
|
|
|
|
@end
|
|
|
|
@interface NSPointerArray (NSArrayConveniences)
|
|
|
|
/** Creates an instance configured to hold objects and prevent them from
|
|
* being garbage collected.
|
|
*/
|
|
+ (id) pointerArrayWithStrongObjects;
|
|
|
|
/** Creates an instance configured to hold objects, allowing them to be
|
|
* garbage collected and replaced by nil if/when they are collected.
|
|
*/
|
|
+ (id) pointerArrayWithWeakObjects;
|
|
|
|
/** Returns an array containing all the non-nil objects from the receiver.
|
|
*/
|
|
- (NSArray*) allObjects;
|
|
|
|
@end
|
|
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif
|
|
|
|
#endif
|