/*
* 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"
#import "OFString.h"
#ifdef OF_AMIGAOS
# include <exec/types.h>
#endif
OF_ASSUME_NONNULL_BEGIN
/** @file */
@class OFSortedList OF_GENERIC(ObjectType);
#ifdef OF_HAVE_THREADS
@class OFMutex;
@class OFCondition;
#endif
#ifdef OF_HAVE_SOCKETS
@class OFKernelEventObserver;
#endif
@class OFMutableDictionary OF_GENERIC(KeyType, ObjectType);
@class OFTimer;
@class OFDate;
/**
* @brief A mode for an OFRunLoop.
*/
typedef OFConstantString *OFRunLoopMode;
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief The default mode for an OFRunLoop.
*/
extern const OFRunLoopMode OFDefaultRunLoopMode;
#ifdef __cplusplus
}
#endif
/**
* @class OFRunLoop OFRunLoop.h ObjFW/ObjFW.h
*
* @brief A class providing a run loop for the application and its processes.
*/
OF_SUBCLASSING_RESTRICTED
@interface OFRunLoop: OFObject
{
OFMutableDictionary *_states;
#ifdef OF_HAVE_THREADS
OFMutex *_statesMutex;
#endif
OFRunLoopMode _Nullable _currentMode;
volatile bool _stop;
}
#ifdef OF_HAVE_CLASS_PROPERTIES
@property (class, readonly, nullable, nonatomic) OFRunLoop *mainRunLoop;
@property (class, readonly, nullable, nonatomic) OFRunLoop *currentRunLoop;
#endif
@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFRunLoopMode currentMode;
/**
* @brief Returns the run loop for the main thread.
*
* @return The run loop for the main thread
*/
+ (nullable OFRunLoop *)mainRunLoop;
/**
* @brief Returns the run loop for the current thread.
*
* @return The run loop for the current thread
*/
+ (nullable OFRunLoop *)currentRunLoop;
/**
* @brief Adds an OFTimer to the run loop.
*
* @param timer The timer to add
*/
- (void)addTimer: (OFTimer *)timer;
/**
* @brief Adds an OFTimer to the run loop for the specified mode.
*
* @param timer The timer to add
* @param mode The run loop mode in which to run the timer
*/
- (void)addTimer: (OFTimer *)timer forMode: (OFRunLoopMode)mode;
#if defined(OF_AMIGAOS) || defined(DOXYGEN)
/**
* @brief Adds an Exec Signal to the run loop.
*
* If a signal is added multiple times, the specified methods will be performed
* in the order added.
*
* @note This is only available on AmigaOS!
*
* @param signal The signal to add
* @param target The target to call when the signal was received
* @param selector The selector to call on the target when the signal was
* received. The selector must have one parameter for the ULONG
* of the signal that was received.
*/
- (void)addExecSignal: (ULONG)signal target: (id)target selector: (SEL)selector;
/**
* @brief Adds an Exec Signal to the run loop for the specified mode.
*
* If a signal is added multiple times, the specified methods will be performed
* in the order added.
*
* @note This is only available on AmigaOS!
*
* @param signal The signal to add
* @param mode The run loop mode in which to handle the signal
* @param target The target to call when the signal was received
* @param selector The selector to call on the target when the signal was
* received. The selector must have one parameter for the ULONG
* of the signal that was received.
*/
- (void)addExecSignal: (ULONG)signal
forMode: (OFRunLoopMode)mode
target: (id)target
selector: (SEL)selector;
/**
* @brief Removes the specified Exec Signal with the specified target and
* selector.
*
* @param signal The signal to remove
* @param target The target which was specified when adding the signal
* @param selector The selector which was specified when adding the signal
*/
- (void)removeExecSignal: (ULONG)signal
target: (id)target
selector: (SEL)selector;
/**
* @brief Removes the specified Exec Signal from the specified mode with the
* specified target and selector.
*
* @param signal The signal to remove
* @param mode The run loop mode to which the signal was added
* @param target The target which was specified when adding the signal
* @param selector The selector which was specified when adding the signal
*/
- (void)removeExecSignal: (ULONG)signal
forMode: (OFRunLoopMode)mode
target: (id)target
selector: (SEL)selector;
#endif
/**
* @brief Starts the run loop.
*/
- (void)run;
/**
* @brief Run the run loop until the specified deadline.
*
* @param deadline The date until which the run loop should run
*/
- (void)runUntilDate: (nullable OFDate *)deadline;
/**
* @brief Run the run loop until an event or timer occurs or the specified
* deadline is reached.
*
* @param mode The mode in which to run the run loop
* @param deadline The date until which the run loop should run at the longest
*/
- (void)runMode: (OFRunLoopMode)mode beforeDate: (nullable OFDate *)deadline;
/**
* @brief Stops the run loop. If there is still an operation being executed, it
* is finished before the run loop stops.
*/
- (void)stop;
@end
OF_ASSUME_NONNULL_END