OFSet.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2024 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/>.
 */
 
#ifndef __STDC_LIMIT_MACROS
# define __STDC_LIMIT_MACROS
#endif
#ifndef __STDC_CONSTANT_MACROS
# define __STDC_CONSTANT_MACROS
#endif
 
#include <stdarg.h>
 
#import "OFObject.h"
#import "OFCollection.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFArray OF_GENERIC(ObjectType);
 
#ifdef OF_HAVE_BLOCKS
typedef void (^OFSetEnumerationBlock)(id object, bool *stop);
 
typedef bool (^OFSetFilterBlock)(id object);
#endif
 
@interface OFSet OF_GENERIC(ObjectType): OFObject <OFCollection, OFCopying,
    OFMutableCopying>
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# define ObjectType id
#endif
@property (readonly, nonatomic) OFArray OF_GENERIC(ObjectType) *allObjects;
 
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) ObjectType anyObject;
 
+ (instancetype)set;
 
+ (instancetype)setWithSet: (OFSet OF_GENERIC(ObjectType) *)set;
 
+ (instancetype)setWithArray: (OFArray OF_GENERIC(ObjectType) *)array;
 
+ (instancetype)setWithObjects: (ObjectType)firstObject, ...;
 
+ (instancetype)setWithObjects: (ObjectType const _Nonnull *_Nonnull)objects
             count: (size_t)count;
 
- (instancetype)init OF_DESIGNATED_INITIALIZER;
 
- (instancetype)initWithSet: (OFSet OF_GENERIC(ObjectType) *)set;
 
- (instancetype)initWithArray: (OFArray OF_GENERIC(ObjectType) *)array;
 
- (instancetype)initWithObjects: (ObjectType)firstObject, ... OF_SENTINEL;
 
- (instancetype)initWithObject: (ObjectType)firstObject
             arguments: (va_list)arguments;
 
- (instancetype)initWithObjects: (ObjectType const _Nonnull *_Nonnull)objects
              count: (size_t)count OF_DESIGNATED_INITIALIZER;
 
- (OFEnumerator OF_GENERIC(ObjectType) *)objectEnumerator;
 
- (bool)isSubsetOfSet: (OFSet OF_GENERIC(ObjectType) *)set;
 
- (bool)intersectsSet: (OFSet OF_GENERIC(ObjectType) *)set;
 
- (OFSet OF_GENERIC(ObjectType) *)setByAddingObjectsFromSet:
    (OFSet OF_GENERIC(ObjectType) *)set;
 
- (bool)containsObject: (ObjectType)object;
 
- (nullable id)valueForKey: (OFString *)key;
 
- (void)setValue: (nullable id)value forKey: (OFString *)key;
 
#ifdef OF_HAVE_BLOCKS
- (void)enumerateObjectsUsingBlock: (OFSetEnumerationBlock)block;
 
- (OFSet OF_GENERIC(ObjectType) *)
    filteredSetUsingBlock: (OFSetFilterBlock)block;
#endif
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# undef ObjectType
#endif
@end
 
OF_ASSUME_NONNULL_END
 
#import "OFMutableSet.h"