// // PAGYYClassInfo.h // PAGYYModel // // This source code is licensed under the MIT-style license found in the // LICENSE file in the root directory of this source tree. // #import #import NS_ASSUME_NONNULL_BEGIN /** Type encoding's type. */ typedef NS_OPTIONS(NSUInteger, PAGYYEncodingType) { PAGYYEncodingTypeMask = 0xFF, ///< mask of type value PAGYYEncodingTypeUnknown = 0, ///< unknown PAGYYEncodingTypeVoid = 1, ///< void PAGYYEncodingTypeBool = 2, ///< bool PAGYYEncodingTypeInt8 = 3, ///< char / BOOL PAGYYEncodingTypeUInt8 = 4, ///< unsigned char PAGYYEncodingTypeInt16 = 5, ///< short PAGYYEncodingTypeUInt16 = 6, ///< unsigned short PAGYYEncodingTypeInt32 = 7, ///< int PAGYYEncodingTypeUInt32 = 8, ///< unsigned int PAGYYEncodingTypeInt64 = 9, ///< long long PAGYYEncodingTypeUInt64 = 10, ///< unsigned long long PAGYYEncodingTypeFloat = 11, ///< float PAGYYEncodingTypeDouble = 12, ///< double PAGYYEncodingTypeLongDouble = 13, ///< long double PAGYYEncodingTypeObject = 14, ///< id PAGYYEncodingTypeClass = 15, ///< Class PAGYYEncodingTypeSEL = 16, ///< SEL PAGYYEncodingTypeBlock = 17, ///< block PAGYYEncodingTypePointer = 18, ///< void* PAGYYEncodingTypeStruct = 19, ///< struct PAGYYEncodingTypeUnion = 20, ///< union PAGYYEncodingTypeCString = 21, ///< char* PAGYYEncodingTypeCArray = 22, ///< char[10] (for example) PAGYYEncodingTypeQualifierMask = 0xFF00, ///< mask of qualifier PAGYYEncodingTypeQualifierConst = 1 << 8, ///< const PAGYYEncodingTypeQualifierIn = 1 << 9, ///< in PAGYYEncodingTypeQualifierInout = 1 << 10, ///< inout PAGYYEncodingTypeQualifierOut = 1 << 11, ///< out PAGYYEncodingTypeQualifierBycopy = 1 << 12, ///< bycopy PAGYYEncodingTypeQualifierByref = 1 << 13, ///< byref PAGYYEncodingTypeQualifierOneway = 1 << 14, ///< oneway PAGYYEncodingTypePropertyMask = 0xFF0000, ///< mask of property PAGYYEncodingTypePropertyReadonly = 1 << 16, ///< readonly PAGYYEncodingTypePropertyCopy = 1 << 17, ///< copy PAGYYEncodingTypePropertyRetain = 1 << 18, ///< retain PAGYYEncodingTypePropertyNonatomic = 1 << 19, ///< nonatomic PAGYYEncodingTypePropertyWeak = 1 << 20, ///< weak PAGYYEncodingTypePropertyCustomGetter = 1 << 21, ///< getter= PAGYYEncodingTypePropertyCustomSetter = 1 << 22, ///< setter= PAGYYEncodingTypePropertyDynamic = 1 << 23, ///< @dynamic }; /** Get the type from a Type-Encoding string. @discussion See also: https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/ObjCRuntimeGuide/Articles/ocrtTypeEncodings.html https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/ObjCRuntimeGuide/Articles/ocrtPropertyIntrospection.html @param typeEncoding A Type-Encoding string. @return The encoding type. */ PAGYYEncodingType PAGYYEncodingGetType(const char *typeEncoding); /** Instance variable information. */ @interface PAGYYClassIvarInfo : NSObject @property (nonatomic, assign, readonly) Ivar ivar; ///< ivar opaque struct @property (nonatomic, strong, readonly) NSString *name; ///< Ivar's name @property (nonatomic, assign, readonly) ptrdiff_t offset; ///< Ivar's offset @property (nonatomic, strong, readonly) NSString *typeEncoding; ///< Ivar's type encoding @property (nonatomic, assign, readonly) PAGYYEncodingType type; ///< Ivar's type /** Creates and returns an ivar info object. @param ivar ivar opaque struct @return A new object, or nil if an error occurs. */ - (instancetype)initWithIvar:(Ivar)ivar; @end /** Method information. */ @interface PAGYYClassMethodInfo : NSObject @property (nonatomic, assign, readonly) Method method; ///< method opaque struct @property (nonatomic, strong, readonly) NSString *name; ///< method name @property (nonatomic, assign, readonly) SEL sel; ///< method's selector @property (nonatomic, assign, readonly) IMP imp; ///< method's implementation @property (nonatomic, strong, readonly) NSString *typeEncoding; ///< method's parameter and return types @property (nonatomic, strong, readonly) NSString *returnTypeEncoding; ///< return value's type @property (nullable, nonatomic, strong, readonly) NSArray *argumentTypeEncodings; ///< array of arguments' type /** Creates and returns a method info object. @param method method opaque struct @return A new object, or nil if an error occurs. */ - (instancetype)initWithMethod:(Method)method; @end /** Property information. */ @interface PAGYYClassPropertyInfo : NSObject @property (nonatomic, assign, readonly) objc_property_t property; ///< property's opaque struct @property (nonatomic, strong, readonly) NSString *name; ///< property's name @property (nonatomic, assign, readonly) PAGYYEncodingType type; ///< property's type @property (nonatomic, strong, readonly) NSString *typeEncoding; ///< property's encoding value @property (nonatomic, strong, readonly) NSString *ivarName; ///< property's ivar name @property (nullable, nonatomic, assign, readonly) Class cls; ///< may be nil @property (nullable, nonatomic, strong, readonly) NSArray *protocols; ///< may nil @property (nonatomic, assign, readonly) SEL getter; ///< getter (nonnull) @property (nonatomic, assign, readonly) SEL setter; ///< setter (nonnull) /** Creates and returns a property info object. @param property property opaque struct @return A new object, or nil if an error occurs. */ - (instancetype)initWithProperty:(objc_property_t)property; @end /** Class information for a class. */ @interface PAGYYClassInfo : NSObject @property (nonatomic, assign, readonly) Class cls; ///< class object @property (nullable, nonatomic, assign, readonly) Class superCls; ///< super class object @property (nullable, nonatomic, assign, readonly) Class metaCls; ///< class's meta class object @property (nonatomic, readonly) BOOL isMeta; ///< whether this class is meta class @property (nonatomic, strong, readonly) NSString *name; ///< class name @property (nullable, nonatomic, strong, readonly) PAGYYClassInfo *superClassInfo; ///< super class's class info @property (nullable, nonatomic, strong, readonly) NSDictionary *ivarInfos; ///< ivars @property (nullable, nonatomic, strong, readonly) NSDictionary *methodInfos; ///< methods @property (nullable, nonatomic, strong, readonly) NSDictionary *propertyInfos; ///< properties /** If the class is changed (for example: you add a method to this class with 'class_addMethod()'), you should call this method to refresh the class info cache. After called this method, `needUpdate` will returns `YES`, and you should call 'classInfoWithClass' or 'classInfoWithClassName' to get the updated class info. */ - (void)setNeedUpdate; /** If this method returns `YES`, you should stop using this instance and call `classInfoWithClass` or `classInfoWithClassName` to get the updated class info. @return Whether this class info need update. */ - (BOOL)needUpdate; /** Get the class info of a specified Class. @discussion This method will cache the class info and super-class info at the first access to the Class. This method is thread-safe. @param cls A class. @return A class info, or nil if an error occurs. */ + (nullable instancetype)classInfoWithClass:(Class)cls; /** Get the class info of a specified Class. @discussion This method will cache the class info and super-class info at the first access to the Class. This method is thread-safe. @param className A class name. @return A class info, or nil if an error occurs. */ + (nullable instancetype)classInfoWithClassName:(NSString *)className; @end NS_ASSUME_NONNULL_END