/*
* 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/>.
*/
#import "OFObject.h"
OF_ASSUME_NONNULL_BEGIN
@class OFArray OF_GENERIC(ObjectType);
@class OFEnumerator OF_GENERIC(ObjectType);
/**
* @protocol OFEnumeration OFEnumerator.h ObjFW/OFEnumerator.h
*
* @brief A protocol for getting an enumerator for the object.
*
* If the class conforming to OFEnumeration is using lightweight generics, the
* only method, @ref objectEnumerator, should be overridden to use lightweight
* generics.
*/
@protocol OFEnumeration
/**
* @brief Returns an OFEnumerator to enumerate through all objects of the
* collection.
*
* @return An OFEnumerator to enumerate through all objects of the collection
*/
- (OFEnumerator *)objectEnumerator;
@end
/*
* This needs to be exactly like this because it's hard-coded in the compiler.
*
* We need this bad check to see if we already imported Cocoa, which defines
* this as well.
*/
/**
* @struct OFFastEnumerationState OFEnumerator.h ObjFW/OFEnumerator.h
*
* @brief State information for fast enumerations.
*/
typedef struct {
/** Arbitrary state information for the enumeration */
unsigned long state;
/** Pointer to a C array of objects to return */
id __unsafe_unretained _Nullable *_Nullable itemsPtr;
/** Arbitrary state information to detect mutations */
unsigned long *_Nullable mutationsPtr;
/** Additional arbitrary state information */
unsigned long extra[5];
} OFFastEnumerationState;
#ifndef NSINTEGER_DEFINED
typedef OFFastEnumerationState NSFastEnumerationState;
#endif
/**
* @protocol OFFastEnumeration OFEnumerator.h ObjFW/OFEnumerator.h
*
* @brief A protocol for fast enumeration.
*
* The OFFastEnumeration protocol needs to be implemented by all classes
* supporting fast enumeration.
*/
@protocol OFFastEnumeration
/**
* @brief A method which is called by the code produced by the compiler when
* doing a fast enumeration.
*
* @param state Context information for the enumeration
* @param objects A pointer to an array where to put the objects
* @param count The number of objects that can be stored at objects
* @return The number of objects returned in objects or 0 when the enumeration
* finished.
* @throw OFEnumerationMutationException The object was mutated during
* enumeration
*/
- (int)countByEnumeratingWithState: (OFFastEnumerationState *)state
objects: (id __unsafe_unretained _Nonnull *_Nonnull)
objects
count: (int)count;
@end
/**
* @class OFEnumerator OFEnumerator.h ObjFW/OFEnumerator.h
*
* @brief A class which provides methods to enumerate through collections.
*/
@interface OFEnumerator OF_GENERIC(ObjectType): OFObject <OFFastEnumeration>
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# define ObjectType id
#endif
/**
* @brief Returns the next object or `nil` if there is none left.
*
* @return The next object or `nil` if there is none left
* @throw OFEnumerationMutationException The object was mutated during
* enumeration
*/
- (nullable ObjectType)nextObject;
/**
* @brief Returns an array of all remaining objects in the collection.
*
* @return An array of all remaining objects in the collection.
*/
- (OFArray OF_GENERIC(ObjectType) *)allObjects;
#if !defined(OF_HAVE_GENERICS) && !defined(DOXYGEN)
# undef ObjectType
#endif
@end
OF_ASSUME_NONNULL_END