OFIntrospection.h

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

#import "OFObject.h"

OF_ASSUME_NONNULL_BEGIN

@class OFArray OF_GENERIC(ObjectType);
@class OFMutableArray OF_GENERIC(ObjectType);
@class OFString;

enum {
    OF_PROPERTY_READONLY    =   0x01,
    OF_PROPERTY_ASSIGN  =   0x04,
    OF_PROPERTY_READWRITE   =   0x08,
    OF_PROPERTY_RETAIN  =   0x10,
    OF_PROPERTY_COPY    =   0x20,
    OF_PROPERTY_NONATOMIC   =   0x40,
    OF_PROPERTY_SYNTHESIZED =  0x100,
    OF_PROPERTY_DYNAMIC =  0x200,
    OF_PROPERTY_ATOMIC  =  0x400,
    OF_PROPERTY_WEAK    =  0x800
};

@interface OFMethod: OFObject
{
    SEL _selector;
    OFString *_name;
    const char *_typeEncoding;
}

@property (readonly, nonatomic) SEL selector;

@property (readonly, nonatomic) OFString *name;

@property OF_NULLABLE_PROPERTY (readonly, nonatomic) const char *typeEncoding;

- init OF_UNAVAILABLE;
@end

@interface OFProperty: OFObject
{
    OFString *_name;
    unsigned _attributes;
    OFString *_Nullable _getter, *_Nullable _setter;
}

@property (readonly, nonatomic) OFString *name;

@property (readonly, nonatomic) unsigned attributes;

@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *getter;

@property OF_NULLABLE_PROPERTY (readonly, nonatomic) OFString *setter;

- init OF_UNAVAILABLE;
@end

@interface OFInstanceVariable: OFObject
{
    OFString *_name;
    const char *_typeEncoding;
    ptrdiff_t _offset;
}

@property (readonly, nonatomic) OFString *name;

@property (readonly, nonatomic) ptrdiff_t offset;

@property OF_NULLABLE_PROPERTY (readonly, nonatomic) const char *typeEncoding;

- init OF_UNAVAILABLE;
@end

@interface OFIntrospection: OFObject
{
    OFMutableArray OF_GENERIC(OFMethod *) *_classMethods;
    OFMutableArray OF_GENERIC(OFMethod *) *_instanceMethods;
    OFMutableArray OF_GENERIC(OFProperty *) *_properties;
    OFMutableArray OF_GENERIC(OFInstanceVariable *) *_instanceVariables;
}

@property (readonly, nonatomic) OFArray OF_GENERIC(OFMethod *) *classMethods;

@property (readonly, nonatomic) OFArray OF_GENERIC(OFMethod *) *instanceMethods;

@property (readonly, nonatomic) OFArray OF_GENERIC(OFProperty *) *properties;

@property (readonly, nonatomic)
    OFArray OF_GENERIC(OFInstanceVariable *) *instanceVariables;

/* TODO: protocols */

+ (instancetype)introspectionWithClass: (Class)class_;

- init OF_UNAVAILABLE;

- initWithClass: (Class)class_ OF_DESIGNATED_INITIALIZER;
@end

OF_ASSUME_NONNULL_END