OFDataArray.h

/*
 * 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;

@interface OFDataArray: OFObject <OFCopying, OFComparing, OFSerialization>
{
    uint8_t *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

+ (instancetype)dataArray;

+ (instancetype)dataArrayWithItemSize: (size_t)itemSize;

+ (instancetype)dataArrayWithContentsOfFile: (OFString*)path;

+ (instancetype)dataArrayWithContentsOfURL: (OFURL*)URL;

+ (instancetype)dataArrayWithStringRepresentation: (OFString*)string;

+ (instancetype)dataArrayWithBase64EncodedString: (OFString*)string;

- initWithItemSize: (size_t)itemSize;

- initWithContentsOfFile: (OFString*)path;

- initWithContentsOfURL: (OFURL*)URL;

- initWithStringRepresentation: (OFString*)string;

- initWithBase64EncodedString: (OFString*)string;

- (size_t)count;

- (size_t)itemSize;

- (void*)cArray OF_RETURNS_INNER_POINTER;

- (void*)itemAtIndex: (size_t)index OF_RETURNS_INNER_POINTER;

- (void*)firstItem OF_RETURNS_INNER_POINTER;

- (void*)lastItem OF_RETURNS_INNER_POINTER;

- (void)addItem: (const void*)item;

- (void)insertItem: (const void*)item
       atIndex: (size_t)index;

- (void)addItemsFromCArray: (const void*)cArray
             count: (size_t)count;

- (void)insertItemsFromCArray: (const void*)cArray
              atIndex: (size_t)index
            count: (size_t)count;

- (void)removeItemAtIndex: (size_t)index;

- (void)removeItemsInRange: (of_range_t)range;

- (void)removeLastItem;

- (void)removeAllItems;

- (OFString*)stringRepresentation;

- (OFString*)stringByBase64Encoding;

- (void)writeToFile: (OFString*)path;
@end

@interface OFBigDataArray: OFDataArray
{
    size_t size;
}
@end

#import "OFDataArray+Hashing.h"