SCRuntimeVariable Class Reference

Representation of a class variable. More...

#import <SCRuntimeVariable.h>

Inheritance diagram for SCRuntimeVariable:

Creating and Initializing Variables
(instancetype)	+ variableWithObjCVariable:
(instancetype)	+ variableWithName:encoding:
(instancetype)	+ variableWithClass:name:
(instancetype)	- initWithObjCVariable:
(instancetype)	- initWithName:encoding:
(instancetype)	- initWithClass:name:

Quering Variables
NSString *	name
NSString *	encoding
ptrdiff_t	offset

Comparing Variables
(BOOL)	- isEqualToVariable:
(BOOL)	- isEqualToName:
(BOOL)	- isEqual:
(BOOL)	- isEqualToObjCVariable:

Communicating with Classes
(BOOL)	- addToClass:
(BOOL)	- availableInClass:
(BOOL)	- availableInUnregisteredClass:

Additional Inherited Members
Instance Methods inherited from SCObject
(instancetype)	- initWithCoder:
(instancetype)	- initWithContentsOfSerializedFile:
(void)	- encodeWithCoder:
(BOOL)	- writeContentsToSerializedFile:
(instancetype)	- initWithDataDictionary:
(instancetype)	- initWithDataDictionaryFromFile:
(void)	- writeToDataDictionary:
(void)	- writeToDataDictionaryFile:atomically:
(void)	- writeToDataDictionaryFile:
(NSDictionary *)	- dataDictionary
(instancetype)	- initWithStream:
(instancetype)	- initWithFileStream:
(void)	- writeToStream:
(void)	- writeToFileStream:
(void)	- appendToFileStream:
(id)	- copyObject
(instancetype)	- initWithData:
(instancetype)	- initWithDataWrapper:
(instancetype)	- initWithContentsOfFile:
(instancetype)	- initWithContentsOfURL:
(instancetype)	- initWithContentsOfURLString:
(void)	- writeToData:
(BOOL)	- writeToFile:
(BOOL)	- writeToURL:
(BOOL)	- writeToURLString:
(NSData *)	- data
Properties inherited from SCObject
NSString *	className

Detailed Description

Representation of a class variable.

SDK

macOS 10.6+, iOS 7.0+, GNUstep

Since

version 1.2.6

Provides access to runtime class variables:

• getting information about existing variables of classes;
• creating new variables;
• access to various variables parameters;
• add variables to unregistered classes.

Class instances can thrown the following exceptions:

• SCL-20081: class runtime error
• SCL-20087: instance variable runtime error

Method Documentation

- (BOOL) addToClass:

(SCRuntimeUnregisteredClass *)

class

Adds a receiving variable to a given unregistered class.

Parameters

class

- an unregistered class

Returns

YES if a variable was successfully added, otherwise NO

Exceptions

SCRuntimeException

- runtime error detected

- (BOOL) availableInClass:

(Class)

class

Returns a boolean value that indicates whether a receiving variable is present in a given class.

Parameters

class

- an existing class

Returns

YES if a receving variable is present in a given class, otherwise NO

- (BOOL) availableInUnregisteredClass:

(SCRuntimeUnregisteredClass *)

class

Returns a boolean value that indicates whether a receiving variable is present in a given unregistered class.

Parameters

class

- an unregistered class

Returns

YES if a receving variable is present in a given class, otherwise NO

- (instancetype) initWithClass:		(Class)	class
name:		(NSString *)	name

Initializes a variable using the specified class and variable name.

Parameters

class	- a class
name	- a variable name

Returns

A newly initialized variable

Exceptions

SCRuntimeException

- runtime error detected

- (instancetype) initWithName:		(NSString *)	name
encoding:		(NSString *)	encoding

Initializes a variable using the specified name and type encoding.

Parameters

name	- a variable name
encoding	- a type encoding

Returns

A newly initialized variable

- (instancetype) initWithObjCVariable:

(Ivar)

variable

Initializes a variable using a given pointer to existing runtime variable.

Parameters

variable

- a pointer to runtime variable

Returns

A newly initialized variable

- (BOOL) isEqual:

(id)

object

Returns a boolean value that indicates whether the receiving variable is equals to a given object.

Parameters

object

- an object with which to compare the receiving variable

Returns

YES if a given object is equals to the receiving variable, otherwise NO

Reimplemented from SCObject.

- (BOOL) isEqualToName:

(NSString *)

name

Returns a boolean value that indicates whether the receiving variable is equals to a variable with a given name.

Parameters

name	- a name of variable with which to compare the receiving variable

Returns

YES if the variable of a given name is equals to the receiving variable, otherwise NO

- (BOOL) isEqualToObjCVariable:

(Ivar)

variable

Returns a boolean value that indicates whether the receiving variable is equals to a pointer to runtime variable.

Parameters

variable

- a pointer to runtime variable with which to compare the receiving variable

Returns

YES if a variable with a given runtime pointer is equals to the receiving variable, otherwise NO

- (BOOL) isEqualToVariable:

(SCRuntimeVariable *)

variable

Returns a boolean value that indicates whether the receiving variable is equals to an another given variable.

Parameters

variable

- the variable with which to compare the receiving variable

Returns

YES if the other variable is equals to the receiving variable, otherwise NO

+ (instancetype) variableWithClass:		(Class)	class
name:		(NSString *)	name

Returns a variable created by using the specified class and variable name.

Parameters

class	- a class
name	- a variable name

Returns

A created variable

Exceptions

SCRuntimeException

- runtime error detected

+ (instancetype) variableWithName:		(NSString *)	name
encoding:		(NSString *)	encoding

Returns a variable created by using the specified name and type encoding.

Parameters

name	- a variable name
encoding	- a type encoding

Returns

A created variable

+ (instancetype) variableWithObjCVariable:

(Ivar)

variable

Returns a variable created by using a given pointer to existing runtime variable.

Parameters

variable

- a pointer to runtime variable

Returns

A created variable

Property Documentation

- (NSString *) encoding

readnonatomicretain

A variable encoding

- (NSString *) name

readnonatomicretain

A variable name

- (ptrdiff_t) offset

readnonatomicassign

A variable offset

---

The documentation for this class was generated from the following files:

• SCRuntimeVariable.h
• SCRuntimeVariable.m