OFDataArray.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
 *   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"
#import "OFMessagePackRepresentation.h"

OF_ASSUME_NONNULL_BEGIN

@class OFString;
@class OFURL;

@interface OFDataArray: OFObject <OFCopying, OFComparing, OFSerialization,
    OFMessagePackRepresentation>
{
    uint8_t *_items;
    size_t _count, _itemSize, _capacity;
}

#ifdef OF_HAVE_PROPERTIES
@property (readonly) void *items;
@property (readonly) size_t count;
@property (readonly) size_t itemSize;
#endif

+ (instancetype)dataArray;

+ (instancetype)dataArrayWithItemSize: (size_t)itemSize;

+ (instancetype)dataArrayWithCapacity: (size_t)capacity;

+ (instancetype)dataArrayWithItemSize: (size_t)itemSize
                 capacity: (size_t)capacity;

#ifdef OF_HAVE_FILES

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

#if defined(OF_HAVE_FILES) || defined(OF_HAVE_SOCKETS)

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

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

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

- initWithItemSize: (size_t)itemSize;

- initWithCapacity: (size_t)capacity;

- initWithItemSize: (size_t)itemSize
      capacity: (size_t)capacity;

#ifdef OF_HAVE_FILES

- initWithContentsOfFile: (OFString*)path;
#endif

#if defined(OF_HAVE_FILES) || defined(OF_HAVE_SOCKETS)

- initWithContentsOfURL: (OFURL*)URL;
#endif

- initWithStringRepresentation: (OFString*)string;

- initWithBase64EncodedString: (OFString*)string;

- (size_t)count;

- (size_t)itemSize;

- (void*)items OF_RETURNS_INNER_POINTER;

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

- (nullable void*)firstItem OF_RETURNS_INNER_POINTER;

- (nullable void*)lastItem OF_RETURNS_INNER_POINTER;

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

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

- (void)addItems: (const void*)items
       count: (size_t)count;

- (void)insertItems: (const void*)items
        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;

#ifdef OF_HAVE_FILES

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

OF_ASSUME_NONNULL_END

#import "OFDataArray+Hashing.h"
#import "OFDataArray+MessagePackValue.h"