OFThread.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012
 *   Jonathan Schleifer <js@webkeks.org>
 *
 * 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.
 */

#import "OFObject.h"
#import "OFTLSKey.h"

#import "threading.h"

/* Haiku used to define this for some unknown reason which causes trouble */
#ifdef protected
# undef protected
#endif

@class OFDate;
@class OFSortedList;
@class OFRunLoop;

#ifdef OF_HAVE_BLOCKS
typedef id (^of_thread_block_t)(id object);
#endif

@interface OFThread: OFObject <OFCopying>
{
#ifdef OF_THREAD_M
@public
#endif
    id object;
#ifndef OF_THREAD_M
@private
#endif
    of_thread_t thread;
    enum {
        OF_THREAD_NOT_RUNNING,
        OF_THREAD_RUNNING,
        OF_THREAD_WAITING_FOR_JOIN
    } running;
#ifdef OF_HAVE_BLOCKS
    of_thread_block_t block;
#endif
    id returnValue;
    OFRunLoop *runLoop;
}

#if defined(OF_HAVE_PROPERTIES) && defined(OF_HAVE_BLOCKS)
@property (copy) of_thread_block_t block;
#endif

+ (instancetype)thread;

+ (instancetype)threadWithObject: (id)object;

#ifdef OF_HAVE_BLOCKS

+ (instancetype)threadWithBlock: (of_thread_block_t)block;
#endif

+ (void)setObject: (id)object
    forTLSKey: (OFTLSKey*)key;

+ (id)objectForTLSKey: (OFTLSKey*)key;

+ (OFThread*)currentThread;

+ (OFThread*)mainThread;

+ (void)sleepForTimeInterval: (double)seconds;

+ (void)sleepUntilDate: (OFDate*)date;

+ (void)yield;

+ (void)terminate;

+ (void)terminateWithObject: (id)object;

+ (void)OF_createMainThread;

- initWithObject: (id)object;

#ifdef OF_HAVE_BLOCKS

- initWithBlock: (of_thread_block_t)block;
#endif

- (id)main;

- (void)handleTermination;

- (void)start;

- (id)join;

- (OFRunLoop*)runLoop;
@end