/usr/include/GNUstep/Foundation/NSPointerArray.h is in libgnustep-base-dev 1.24.9-3.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 | /**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(MAC_OS_X_VERSION_10_5, 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;
/** Returns a new pointer array for storing strong (retained) references to
* objects.
*/
+ (id) strongObjectsPointerArray;
/** Returns a new pointer array for storing zeroing weak references to objects.
*/
+ (id) weakObjectsPointerArray;
/** 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 specified 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
|