OFSet.h

Go to the documentation of this file.

/*
 * 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.
 */

#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"
#import "OFSerialization.h"

OF_ASSUME_NONNULL_BEGIN

@class OFArray OF_GENERIC(ObjectType);

#ifdef OF_HAVE_BLOCKS

typedef void (^of_set_enumeration_block_t)(id object, bool *stop);

typedef bool (^of_set_filter_block_t)(id object);
#endif

@interface OFSet OF_GENERIC(ObjectType): OFObject <OFCollection, OFCopying,
    OFMutableCopying, OFSerialization>
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# define ObjectType id
#endif

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

- initWithSet: (OFSet OF_GENERIC(ObjectType) *)set;

- initWithArray: (OFArray OF_GENERIC(ObjectType) *)array;

- initWithObjects: (ObjectType)firstObject, ...;

- initWithObjects: (ObjectType const _Nonnull *_Nonnull)objects
        count: (size_t)count;

- initWithObject: (ObjectType)firstObject
       arguments: (va_list)arguments;

- (bool)isSubsetOfSet: (OFSet OF_GENERIC(ObjectType) *)set;

- (bool)intersectsSet: (OFSet OF_GENERIC(ObjectType) *)set;

- (OFSet OF_GENERIC(ObjectType) *)setBySubtractingSet:
    (OFSet OF_GENERIC(ObjectType) *)set;

- (OFSet OF_GENERIC(ObjectType) *)setByIntersectingWithSet:
    (OFSet OF_GENERIC(ObjectType) *)set;

- (OFSet OF_GENERIC(ObjectType) *)setByAddingSet:
    (OFSet OF_GENERIC(ObjectType) *)set;

- (OFArray OF_GENERIC(ObjectType) *)allObjects;

- (nullable ObjectType)anyObject;

- (bool)containsObject: (ObjectType)object;

- (nullable id)valueForKey: (OFString *)key;

- (void)setValue: (id)value
      forKey: (OFString *)key;

- (OFEnumerator OF_GENERIC(ObjectType) *)objectEnumerator;

#ifdef OF_HAVE_BLOCKS

- (void)enumerateObjectsUsingBlock: (of_set_enumeration_block_t)block;

- (OFSet OF_GENERIC(ObjectType) *)filteredSetUsingBlock:
    (of_set_filter_block_t)block;
#endif
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# undef ObjectType
#endif
@end

OF_ASSUME_NONNULL_END

#import "OFMutableSet.h"