Skip to content
This repository
Fetching contributors…

Cannot retrieve contributors at this time

file 266 lines (234 sloc) 6.968 kb
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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
/*
* Copyright (c) 2008, 2009, 2010, 2011, 2012
* Jonathan Schleifer <js@webkeks.org>
*
* All rights reserved.
*
* This file is part of ObjFW. It may be distributed under the terms of the
* Q Public License 1.0, which can be found in the file LICENSE.QPL included in
* the packaging of this file.
*
* Alternatively, it may be distributed under the terms of the GNU General
* Public License, either version 2 or 3, which can be found in the file
* LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
* file.
*/

#import "OFObject.h"
#import "OFSerialization.h"

@class OFString;
@class OFURL;

/**
* \brief A class for storing arbitrary data in an array.
*
* If you plan to store large hunks of data, you should consider using
* OFBigDataArray, which allocates the memory in pages rather than in bytes.
*
* For security reasons, serialization and deserialization is only implemented
* for OFDataArrays with item size 1.
*/
@interface OFDataArray: OFObject <OFCopying, OFComparing, OFSerialization>
{
char *data;
size_t count;
size_t itemSize;
}

#ifdef OF_HAVE_PROPERTIES
@property (readonly, getter=cArray) void *data;
@property (readonly) size_t count;
@property (readonly) size_t itemSize;
#endif

/**
* \brief Creates a new OFDataArray with an item size of 1.
*
* \return A new autoreleased OFDataArray
*/
+ dataArray;

/**
* \brief Creates a new OFDataArray whose items all have the same size.
*
* \param itemSize The size of each element in the OFDataArray
* \return A new autoreleased OFDataArray
*/
+ dataArrayWithItemSize: (size_t)itemSize;

/**
* \brief Creates a new OFDataArary with an item size of 1, containing the data
* of the specified file.
*
* \param path The path of the file
* \return A new autoreleased OFDataArray
*/
+ dataArrayWithContentsOfFile: (OFString*)path;

/**
* \brief Creates a new OFDataArray with an item size of 1, containing the data
* of the specified URL.
*
* \param URL The URL to the contents for the OFDataArray
* \return A new autoreleased OFDataArray
*/
+ dataArrayWithContentsOfURL: (OFURL*)URL;

/**
* \brief Creates a new OFDataArray with an item size of 1, containing the data
* of the Base64-encoded string.
*
* \param string The string with the Base64-encoded data
* \return A new autoreleased OFDataArray
*/
+ dataArrayWithBase64EncodedString: (OFString*)string;

/**
* \brief Initializes an already allocated OFDataArray with an item size of 1.
*
* \return A initialized OFDataArray
*/
- init;

/**
* \brief Initializes an already allocated OFDataArray whose items all have the
* same size.
*
* \param itemSize The size of each element in the OFDataArray
* \return An initialized OFDataArray
*/
- initWithItemSize: (size_t)itemSize;

/**
* \brief Initializes an already allocated OFDataArray with an item size of 1,
* containing the data of the specified file.
*
* \param path The path of the file
* \return An initialized OFDataArray
*/
- initWithContentsOfFile: (OFString*)path;

/**
* \brief Initializes an already allocated OFDataArray with an item size of 1,
* containing the data of the specified URL.
*
* \param URL The URL to the contents for the OFDataArray
* \return A new autoreleased OFDataArray
*/
- initWithContentsOfURL: (OFURL*)URL;

/**
* \brief Initializes an already allocated OFDataArray with an item size of 1,
* containing the data of the Base64-encoded string.
*
* \param string The string with the Base64-encoded data
* \return A initialized OFDataArray
*/
- initWithBase64EncodedString: (OFString*)string;

/**
* \brief Returns the number of items in the OFDataArray.
*
* \return The number of items in the OFDataArray
*/
- (size_t)count;

/**
* \brief Returns the size of each item in the OFDataArray in bytes.
*
* \return The size of each item in the OFDataArray in bytes
*/
- (size_t)itemSize;

/**
* \brief Returns all elements of the OFDataArray as a C array.
*
* \warning The pointer is only valid until the OFDataArray is changed!
*
* Modifying the returned array directly is allowed and will change the contents
* of the data array.
*
* \return All elements of the OFDataArray as a C array
*/
- (void*)cArray OF_RETURNS_INNER_POINTER;

/**
* \brief Returns a specific item of the OFDataArray.
*
* \param index The number of the item to return
* \return The specified item of the OFDataArray
*/
- (void*)itemAtIndex: (size_t)index OF_RETURNS_INNER_POINTER;

/**
* \brief Returns the first item of the OFDataArray.
*
* \return The first item of the OFDataArray or NULL
*/
- (void*)firstItem OF_RETURNS_INNER_POINTER;

/**
* \brief Returns the last item of the OFDataArray.
*
* \return The last item of the OFDataArray or NULL
*/
- (void*)lastItem OF_RETURNS_INNER_POINTER;

/**
* \brief Adds an item to the OFDataArray.
*
* \param item A pointer to an arbitrary item
*/
- (void)addItem: (const void*)item;

/**
* \brief Adds an item to the OFDataArray at the specified index.
*
* \param item A pointer to an arbitrary item
* \param index The index where the item should be added
*/
- (void)insertItem: (const void*)item
atIndex: (size_t)index;

/**
* \brief Adds items from a C array to the OFDataArray.
*
* \param count The number of items to add
* \param cArray A C array containing the items to add
*/
- (void)addItemsFromCArray: (const void*)cArray
count: (size_t)count;

/**
* \brief Adds items from a C array to the OFDataArray at the specified index.
*
* \param cArray A C array containing the items to add
* \param index The index where the items should be added
* \param count The number of items to add
*/
- (void)insertItemsFromCArray: (const void*)cArray
atIndex: (size_t)index
count: (size_t)count;

/**
* \brief Removes the item at the specified index.
*
* \param index The index of the item to remove
*/
- (void)removeItemAtIndex: (size_t)index;

/**
* \brief Removes the specified amount of items at the specified index.
*
* \param range The range of items to remove
*/
- (void)removeItemsInRange: (of_range_t)range;

/**
* \brief Removes the last item.
*/
- (void)removeLastItem;

/**
* \brief Removes all items.
*/
- (void)removeAllItems;

/**
* \brief Returns a string containing the data in Base64 encoding.
*
* \return A string containing the data in Base64 encoding
*/
- (OFString*)stringByBase64Encoding;

/**
* \brief Writes the OFDataArray into the specified file.
*
* \param path The path of the file to write to
*/
- (void)writeToFile: (OFString*)path;
@end

/**
* \brief A class for storing arbitrary big data in an array.
*
* The OFBigDataArray class is a class for storing arbitrary data in an array
* and is designed to store large hunks of data. Therefore, it allocates
* memory in pages rather than a chunk of memory for each item.
*/
@interface OFBigDataArray: OFDataArray
{
size_t size;
}
@end

#import "OFDataArray+Hashing.h"
Something went wrong with that request. Please try again.