libobjc2/include/properties.h

#include "visibility.h"
#include <assert.h>

enum PropertyAttributeKind 
{
	/**
	 * Property has no attributes.
	 */
	OBJC_PR_noattr    = 0x00,
	/**
	 * The property is declared read-only.
	 */
	OBJC_PR_readonly  = (1<<0),
	/**
	 * The property has a getter.
	 */
	OBJC_PR_getter    = (1<<1),
	/**
	 * The property has assign semantics.
	 */
	OBJC_PR_assign    = (1<<2),
	/**
	 * The property is declared read-write.
	 */
	OBJC_PR_readwrite = (1<<3),
	/**
	 * Property has retain semantics.
	 */
	OBJC_PR_retain    = (1<<4),
	/**
	 * Property has copy semantics.
	 */
	OBJC_PR_copy      = (1<<5),
	/**
	 * Property is marked as non-atomic.
	 */
	OBJC_PR_nonatomic = (1<<6),
	/**
	 * Property has setter.
	 */
	OBJC_PR_setter    = (1<<7)
};

/**
 * Flags in the second attributes field in declared properties.
 * Note: This field replaces the old 'is synthesized' field and so these values
 * are shifted left one from their values in clang.
 */
enum PropertyAttributeKind2
{
	/**
	 * No extended attributes.
	 */
	OBJC_PR_noextattr         = 0,
	/**
	 * The property is synthesized.  This has no meaning in properties on
	 * protocols.
	 */
	OBJC_PR_synthesized       = (1<<0),
	/**
	 * The property is dynamic (i.e. the implementation is inherited or
	 * provided at run time).
	 */
	OBJC_PR_dynamic           = (1<<1),
	/**
	 * This property belongs to a protocol.
	 */
	OBJC_PR_protocol          = OBJC_PR_synthesized | OBJC_PR_dynamic,
	/**
	 * The property is atomic.
	 */
	OBJC_PR_atomic            = (1<<2),
	/**
	 * The property value is a zeroing weak reference.
	 */
	OBJC_PR_weak              = (1<<3),
	/**
	 * The property value is strong (retained).  Currently, this is equivalent
	 * to the strong attribute.
	 */
	OBJC_PR_strong            = (1<<4),
	/**
	 * The property value is just copied.
	 */
	OBJC_PR_unsafe_unretained = (1<<5),
};

/**
 * Structure used for property enumeration.  Note that property enumeration is
 * currently quite broken on OS X, so achieving full compatibility there is
 * impossible.  Instead, we strive to achieve compatibility with the
 * documentation.
 */
// begin: objc_property
struct objc_property
{
	/**
	 * Name of this property.
	 */
	const char *name;
	/**
	 * The type encoding of the property.
	 */
	const char *attributes;
	/**
	 * The type encoding of the property.
	 */
	const char *type;
	/**
	 * The selector for the getter for this property.
	 */
	SEL getter;
	/**
	 * The selector for the setter for this property.
	 */
	SEL setter;
};
// end: objc_property

/**
 * GNUstep v1 ABI version of `struct objc_property`
 */
struct objc_property_gsv1
{
	/**
	 * Name of this property.
	 */
	const char *name;
	/**
	 * Attributes for this property.  Made by ORing together
	 * PropertyAttributeKinds.
	 */
	char attributes;
	/**
	 * Flag set if the property is synthesized.
	 */
	char attributes2;
	/**
	 * Padding field.  These were implicit in the structure field alignment
	 * (four more on 64-bit platforms), but we'll make them explicit now for
	 * future use.
	 */
	char unused1;
	/**
	 * More padding.
	 */
	char unused2;
	/**
	 * Name of the getter for this property.
	 */
	const char *getter_name;
	/**
	 * Type encoding for the get method for this property.
	 */
	const char *getter_types;
	/**
	 * Name of the set method for this property.
	 */
	const char *setter_name;
	/**
	 * Type encoding of the setter for this property.
	 */
	const char *setter_types;
};

/**
 * List of property introspection data.
 */
struct objc_property_list_gsv1
{
	/**
	 * Number of properties in this array.
	 */
	int count;
	/* 
	 * The next property in a linked list.
	 */
	struct objc_property_list *next; 
	/**
	 * List of properties.
	 */
	struct objc_property_gsv1 properties[];
};

/**
 * List of property introspection data.
 */
// begin: objc_property_list
struct objc_property_list
{
	/**
	 * Number of properties in this array.
	 */
	int count;
	/**
	 * Size of `struct objc_property`.  This allows the runtime to
	 * transparently support newer ABIs with more fields in the property
	 * metadata.
	 */
	int size;
	/*
	 * The next property in a linked list.
	 */
	struct objc_property_list *next;
	/**
	 * List of properties.
	 */
	struct objc_property properties[];
};
// end: objc_property_list

/**
 * Returns a pointer to the property inside the `objc_property` structure.
 * This structure is designed to allow the compiler to add other fields without
 * breaking the ABI, so although the `properties` field appears to be an array
 * of `objc_property` structures, it may be an array of some future version of
 * `objc_property` structs, which have fields appended that this version of the
 * runtime does not know about.
 */
static inline struct objc_property *property_at_index(struct objc_property_list *l, int i)
{
	assert(l->size >= sizeof(struct objc_property));
	return (struct objc_property*)(((char*)l->properties) + (i * l->size));
}

/**
 * Constructs a property description from a list of attributes, returning the
 * instance variable name via the third parameter.
 */
PRIVATE struct objc_property propertyFromAttrs(const objc_property_attribute_t *attributes,
                                               unsigned int attributeCount,
                                               const char *name);

/**
 * Constructs and installs a property attribute string from the property
 * attributes and, optionally, an ivar string.
 */
PRIVATE const char *constructPropertyAttributes(objc_property_t property,
                                                const char *iVarName);