OFSecureData.h

/*
 * Copyright (c) 2008-2025 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program 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 Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#import "OFData.h"
 
OF_ASSUME_NONNULL_BEGIN

OF_SUBCLASSING_RESTRICTED
@interface OFSecureData: OFData
{
    unsigned char *_Nullable _items;
    size_t _count, _itemSize;
    bool _freeWhenDone, _allowsSwappableMemory;
    void *_page;
}

@property (readonly, nonatomic) bool allowsSwappableMemory;

@property (readonly, nonatomic) void *mutableItems OF_RETURNS_INNER_POINTER;

+ (void)preallocateUnswappableMemoryWithSize: (size_t)size;

+ (instancetype)dataWithCount: (size_t)count
    allowsSwappableMemory: (bool)allowsSwappableMemory;

+ (instancetype)dataWithCount: (size_t)count
             itemSize: (size_t)itemSize
    allowsSwappableMemory: (bool)allowsSwappableMemory;
 
+ (instancetype)dataWithItems: (const void *)items
            count: (size_t)count OF_UNAVAILABLE;
+ (instancetype)dataWithItems: (const void *)items
            count: (size_t)count
             itemSize: (size_t)itemSize OF_UNAVAILABLE;
+ (instancetype)dataWithItemsNoCopy: (void *)items
                  count: (size_t)count
               freeWhenDone: (bool)freeWhenDone OF_UNAVAILABLE;
+ (instancetype)dataWithItemsNoCopy: (void *)items
                  count: (size_t)count
               itemSize: (size_t)itemSize
               freeWhenDone: (bool)freeWhenDone OF_UNAVAILABLE;
#ifdef OF_HAVE_FILES
+ (instancetype)dataWithContentsOfFile: (OFString *)path OF_UNAVAILABLE;
#endif
+ (instancetype)dataWithContentsOfIRI: (OFIRI *)IRI OF_UNAVAILABLE;
+ (instancetype)dataWithStringRepresentation: (OFString *)string OF_UNAVAILABLE;
+ (instancetype)dataWithBase64EncodedString: (OFString *)string OF_UNAVAILABLE;

- (instancetype)initWithCount: (size_t)count
    allowsSwappableMemory: (bool)allowsSwappableMemory;

- (instancetype)initWithCount: (size_t)count
             itemSize: (size_t)itemSize
    allowsSwappableMemory: (bool)allowsSwappableMemory
    OF_DESIGNATED_INITIALIZER;
 
- (instancetype)init OF_UNAVAILABLE;
- (instancetype)initWithItemSize: (size_t)itemSize OF_UNAVAILABLE;
- (instancetype)initWithItems: (const void *)items
            count: (size_t)count OF_UNAVAILABLE;
- (instancetype)initWithItems: (const void *)items
            count: (size_t)count
             itemSize: (size_t)itemSize OF_UNAVAILABLE;
- (instancetype)initWithItemsNoCopy: (void *)items
                  count: (size_t)count
               freeWhenDone: (bool)freeWhenDone OF_UNAVAILABLE;
- (instancetype)initWithItemsNoCopy: (void *)items
                  count: (size_t)count
               itemSize: (size_t)itemSize
               freeWhenDone: (bool)freeWhenDone OF_UNAVAILABLE;
#ifdef OF_HAVE_FILES
- (instancetype)initWithContentsOfFile: (OFString *)path OF_UNAVAILABLE;
#endif
- (instancetype)initWithContentsOfIRI: (OFIRI *)IRI OF_UNAVAILABLE;
- (instancetype)initWithStringRepresentation: (OFString *)string OF_UNAVAILABLE;
- (instancetype)initWithBase64EncodedString: (OFString *)string OF_UNAVAILABLE;

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

- (bool)isEqual: (nullable id)object;

- (void)zero;
 
- (OFString *)stringRepresentation OF_UNAVAILABLE;
- (OFString *)stringByBase64Encoding OF_UNAVAILABLE;
#ifdef OF_HAVE_FILES
- (void)writeToFile: (OFString *)path OF_UNAVAILABLE;
#endif
- (void)writeToIRI: (OFIRI *)IRI OF_UNAVAILABLE;
- (OFData *)messagePackRepresentation OF_UNAVAILABLE;
@end
 
OF_ASSUME_NONNULL_END