OFIndexSet.h

/*
 * Copyright (c) 2008-2026 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 "OFObject.h"

OF_ASSUME_NONNULL_BEGIN

@class OFMutableData;

@interface OFIndexSet: OFObject <OFCopying, OFMutableCopying>
{
    OFMutableData *_ranges;
    size_t _count;
    OF_RESERVE_IVARS(OFIndexSet, 4)
}

@property (readonly, nonatomic) size_t count;

@property (readonly, nonatomic) size_t firstIndex;

@property (readonly, nonatomic) size_t lastIndex;

+ (instancetype)indexSet;

+ (instancetype)indexSetWithIndexSet: (OFIndexSet *)indexSet;

+ (instancetype)indexSetWithIndex: (size_t)idx;

+ (instancetype)indexSetWithIndexesInRange: (OFRange)range;

- (instancetype)init;

- (instancetype)initWithIndexSet: (OFIndexSet *)indexSet;

- (instancetype)initWithIndex: (size_t)idx;

- (instancetype)initWithIndexesInRange: (OFRange)range;

- (bool)containsIndex: (size_t)idx;

- (bool)containsIndexesInRange: (OFRange)range;

- (size_t)indexGreaterThanIndex: (size_t)idx;

- (size_t)indexGreaterThanOrEqualToIndex: (size_t)idx;

- (size_t)indexLessThanIndex: (size_t)idx;

- (size_t)indexLessThanOrEqualToIndex: (size_t)idx;

- (size_t)getIndexes: (size_t *)indexes
        maxCount: (size_t)maxCount
    inIndexRange: (nullable OFRange *)range;

- (size_t)countOfIndexesInRange: (OFRange)range;
@end

OF_ASSUME_NONNULL_END

#import "OFMutableIndexSet.h"