OFMutableData.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
 *   Jonathan Schleifer <js@heap.zone>
 *
 * 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 "OFData.h"

OF_ASSUME_NONNULL_BEGIN

@class OFString;
@class OFURL;

@interface OFMutableData: OFData
{
    size_t _capacity;
}

+ (instancetype)data;

+ (instancetype)dataWithItemSize: (size_t)itemSize;

+ (instancetype)dataWithCapacity: (size_t)capacity;

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

+ (instancetype)dataWithItemsNoCopy: (const void *)items
                  count: (size_t)count
               freeWhenDone: (bool)freeWhenDone OF_UNAVAILABLE;
+ (instancetype)dataWithItemsNoCopy: (const void *)items
               itemSize: (size_t)itemSize
                  count: (size_t)count
               freeWhenDone: (bool)freeWhenDone OF_UNAVAILABLE;

- init;

- initWithItemSize: (size_t)itemSize;

- initWithCapacity: (size_t)capacity;

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

- initWithItemsNoCopy: (const void *)items
        count: (size_t)count
     freeWhenDone: (bool)freeWhenDone OF_UNAVAILABLE;
- initWithItemsNoCopy: (const void *)items
         itemSize: (size_t)itemSize
        count: (size_t)count
     freeWhenDone: (bool)freeWhenDone OF_UNAVAILABLE;

- (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;

- (void)makeImmutable;
@end

@interface OFMutableData (MutableRetrieving)
- (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;
@end

OF_ASSUME_NONNULL_END