OFObject.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 "objfw-defs.h"

#ifndef __STDC_LIMIT_MACROS
# define __STDC_LIMIT_MACROS
#endif
#ifndef __STDC_CONSTANT_MACROS
# define __STDC_CONSTANT_MACROS
#endif

#include <stddef.h>
#include <stdint.h>
#include <limits.h>

#ifdef OF_OBJFW_RUNTIME
# import "runtime.h"
#else
# import <objc/objc.h>
#endif

#ifdef OF_APPLE_RUNTIME
# import <objc/runtime.h>
#endif

#if defined(__GNUC__)
# define restrict __restrict__
#elif __STDC_VERSION__ < 199901L
# define restrict
#endif

#ifndef __has_feature
# define __has_feature(x) 0
#endif

#ifdef __GNUC__
# define __GCC_VERSION__ (__GNUC__ * 100 + __GNUC_MINOR__)
#else
# define __GCC_VERSION__ 0
#endif

#if defined(__clang__)
# define OF_HAVE_PROPERTIES
# define OF_HAVE_OPTIONAL_PROTOCOLS
# define OF_HAVE_FAST_ENUMERATION
#elif __GCC_VERSION__ >= 406
# define OF_HAVE_PROPERTIES
# define OF_HAVE_OPTIONAL_PROTOCOLS
# define OF_HAVE_FAST_ENUMERATION
#endif

#if !__has_feature(objc_instancetype)
# define instancetype id
#endif

#if __has_feature(blocks)
# define OF_HAVE_BLOCKS
#endif

#if __has_feature(objc_bool)
# undef YES
# define YES __objc_yes
# undef NO
# define NO __objc_no
#endif

#if defined(__clang__) || __GCC_VERSION__ >= 406
# define OF_SENTINEL __attribute__((sentinel))
#else
# define OF_SENTINEL
#endif

#if __has_feature(objc_arc)
# define OF_RETURNS_RETAINED __attribute__((ns_returns_retained))
# define OF_RETURNS_NOT_RETAINED __attribute__((ns_returns_not_retained))
# define OF_RETURNS_INNER_POINTER __attribute__((objc_returns_inner_pointer))
# define OF_CONSUMED __attribute__((ns_consumed))
# define OF_WEAK_UNAVAILABLE __attribute__((objc_arc_weak_unavailable))
#else
# define OF_RETURNS_RETAINED
# define OF_RETURNS_NOT_RETAINED
# define OF_RETURNS_INNER_POINTER
# define OF_CONSUMED
# define OF_WEAK_UNAVAILABLE
# define __unsafe_unretained
# define __bridge
# define __autoreleasing
#endif

#define OF_RETAIN_COUNT_MAX UINT_MAX
#define OF_NOT_FOUND SIZE_MAX

typedef enum of_comparison_result_t {
    OF_ORDERED_ASCENDING = -1,
    OF_ORDERED_SAME = 0,
    OF_ORDERED_DESCENDING = 1
} of_comparison_result_t;

typedef enum of_byte_order_t {
    OF_BYTE_ORDER_BIG_ENDIAN,
    OF_BYTE_ORDER_LITTLE_ENDIAN
} of_byte_order_t;

typedef struct of_range_t {
    size_t location;
    size_t length;
} of_range_t;

typedef struct of_point_t {
    float x;
    float y;
} of_point_t;

typedef struct of_dimension_t {
    float width;
    float height;
} of_dimension_t;

typedef struct of_rectangle_t
{
    of_point_t origin;
    of_dimension_t size;
} of_rectangle_t;

@class OFString;
@class OFThread;

@protocol OFObject
- (Class)class;

- (BOOL)isKindOfClass: (Class)class_;

- (BOOL)isMemberOfClass: (Class)class_;

- (BOOL)respondsToSelector: (SEL)selector;

- (BOOL)conformsToProtocol: (Protocol*)protocol;

- (IMP)methodForSelector: (SEL)selector;

- (const char*)typeEncodingForSelector: (SEL)selector;

- (id)performSelector: (SEL)selector;

- (id)performSelector: (SEL)selector
       withObject: (id)object;

- (id)performSelector: (SEL)selector
       withObject: (id)object1
       withObject: (id)object2;

- (BOOL)isEqual: (id)object;

- (uint32_t)hash;

- retain;

- (unsigned int)retainCount;

- (void)release;

- autorelease;

- self;

- (BOOL)isProxy;
@end

@interface OFObject <OFObject>
{
@public
    Class isa;
}

+ (void)load;

+ (void)initialize;

+ alloc;

+ new;

+ (Class)class;

+ (OFString*)className;

+ (BOOL)isSubclassOfClass: (Class)class_;

+ (Class)superclass;

+ (BOOL)instancesRespondToSelector: (SEL)selector;

+ (BOOL)conformsToProtocol: (Protocol*)protocol;

+ (IMP)instanceMethodForSelector: (SEL)selector;

+ (const char*)typeEncodingForInstanceSelector: (SEL)selector;

+ (OFString*)description;

+ (IMP)replaceClassMethod: (SEL)selector
      withMethodFromClass: (Class)class_;

+ (IMP)replaceInstanceMethod: (SEL)selector
     withMethodFromClass: (Class)class_;

+ (IMP)replaceClassMethod: (SEL)selector
       withImplementation: (IMP)implementation
         typeEncoding: (const char*)typeEncoding;

+ (IMP)replaceInstanceMethod: (SEL)selector
      withImplementation: (IMP)implementation
        typeEncoding: (const char*)typeEncoding;

+ (void)inheritMethodsFromClass: (Class)class_;

+ (BOOL)resolveClassMethod: (SEL)selector;

+ (BOOL)resolveInstanceMethod: (SEL)selector;

- init;

- (OFString*)className;

- (OFString*)description;

- (void*)allocMemoryWithSize: (size_t)size;

- (void*)allocMemoryWithSize: (size_t)size
               count: (size_t)count;

- (void*)resizeMemory: (void*)pointer
         size: (size_t)size;

- (void*)resizeMemory: (void*)pointer
         size: (size_t)size
        count: (size_t)count;

- (void)freeMemory: (void*)pointer;

- (void)dealloc;

- (void)performSelector: (SEL)selector
         afterDelay: (double)delay;

- (void)performSelector: (SEL)selector
         withObject: (id)object
         afterDelay: (double)delay;

- (void)performSelector: (SEL)selector
         withObject: (id)object1
         withObject: (id)object2
         afterDelay: (double)delay;

- (void)performSelector: (SEL)selector
           onThread: (OFThread*)thread
      waitUntilDone: (BOOL)waitUntilDone;

- (void)performSelector: (SEL)selector
           onThread: (OFThread*)thread
         withObject: (id)object
      waitUntilDone: (BOOL)waitUntilDone;

- (void)performSelector: (SEL)selector
           onThread: (OFThread*)thread
         withObject: (id)object1
         withObject: (id)object2
      waitUntilDone: (BOOL)waitUntilDone;

- (void)performSelectorOnMainThread: (SEL)selector
              waitUntilDone: (BOOL)waitUntilDone;

- (void)performSelectorOnMainThread: (SEL)selector
             withObject: (id)object
              waitUntilDone: (BOOL)waitUntilDone;

- (void)performSelectorOnMainThread: (SEL)selector
             withObject: (id)object1
             withObject: (id)object2
              waitUntilDone: (BOOL)waitUntilDone;

- (void)performSelector: (SEL)selector
           onThread: (OFThread*)thread
         afterDelay: (double)delay;

- (void)performSelector: (SEL)selector
           onThread: (OFThread*)thread
         withObject: (id)object
         afterDelay: (double)delay;

- (void)performSelector: (SEL)selector
           onThread: (OFThread*)thread
         withObject: (id)object1
         withObject: (id)object2
         afterDelay: (double)delay;
@end

@protocol OFCopying
- copy;
@end

@protocol OFMutableCopying
- mutableCopy;
@end

@protocol OFComparing <OFObject>
- (of_comparison_result_t)compare: (id <OFComparing>)object;
@end

#import "OFObject+Serialization.h"

#ifdef __cplusplus
extern "C" {
#endif
extern size_t of_pagesize;
extern size_t of_num_cpus;
extern id of_alloc_object(Class class_, size_t extraSize, size_t extraAlignment,
    void **extra);
#ifdef __cplusplus
}
#endif