OFIntrospection.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
 *   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"

OF_ASSUME_NONNULL_BEGIN

@class OFString;
#ifndef DOXYGEN
@class OFArray OF_GENERIC(ObjectType);
@class OFMutableArray OF_GENERIC(ObjectType);
#endif

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;
}

#ifdef OF_HAVE_PROPERTIES
@property (readonly) SEL selector;
@property (readonly, copy) OFString *name;
@property OF_NULLABLE_PROPERTY (assign, readonly) const char *typeEncoding;
#endif

- (SEL)selector;

- (OFString*)name;

- (nullable const char*)typeEncoding;
@end

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

#ifdef OF_HAVE_PROPERTIES
@property (readonly, copy) OFString *name;
@property (readonly) unsigned attributes;
@property OF_NULLABLE_PROPERTY (copy, readonly) OFString *getter, *setter;
#endif

- (OFString*)name;

- (unsigned)attributes;

- (nullable OFString*)getter;

- (nullable OFString*)setter;
@end

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

#ifdef OF_HAVE_PROPERTIES
@property (readonly, copy) OFString *name;
@property (readonly) ptrdiff_t offset;
@property OF_NULLABLE_PROPERTY (assign, readonly) const char *typeEncoding;
#endif

- (OFString*)name;

- (ptrdiff_t)offset;

- (nullable const char*)typeEncoding;
@end

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

#ifdef OF_HAVE_PROPERTIES
@property (readonly, copy) OFArray OF_GENERIC(OFMethod*) *classMethods;
@property (readonly, copy) OFArray OF_GENERIC(OFMethod*) *instanceMethods;
@property (readonly, copy) OFArray OF_GENERIC(OFProperty*) *properties;
@property (readonly, copy)
    OFArray OF_GENERIC(OFInstanceVariable*) *instanceVariables;
#endif

+ (instancetype)introspectionWithClass: (Class)class_;

- initWithClass: (Class)class_;

- (OFArray OF_GENERIC(OFMethod*)*)classMethods;

- (OFArray OF_GENERIC(OFMethod*)*)instanceMethods;

- (OFArray OF_GENERIC(OFProperty*)*)properties;

- (OFArray OF_GENERIC(OFInstanceVariable*)*)instanceVariables;

/* TODO: protocols */
@end

OF_ASSUME_NONNULL_END