NSLocking class documentation

Authors

Generated by builder

Contents -

  1. Software documentation for the NSLocking class
  2. Software documentation for the MakeReleaseSelectorNotFoundErrorGoAway protocol
  3. Macros macros
  4. Macros functions

Software documentation for the NSLocking class

NSLocking

Declared in:
Macros.h
Description forthcoming.
Method summary

lock 

- (void) lock;
Description forthcoming.

unlock 

- (void) unlock;
Description forthcoming.

Software documentation for the MakeReleaseSelectorNotFoundErrorGoAway protocol

MakeReleaseSelectorNotFoundErrorGoAway

Declared in:
Macros.h
Description forthcoming.
Method summary

release 

- (void) release;
Description forthcoming.

Macros macros

A

A(...)

Shortcut macro to create a NSArray. Same as +[NSArray dictionaryWithObjects:].


D

D(...)

Shortcut macro to create a NSDictionary. Same as +[NSDictionary dictionaryWithObjectsAndKeys:].


DEALLOC

DEALLOC(x)

Macro for creating dealloc methods.


ETAssert

ETAssert(condition)

Basic assertion macro that just reports the tested condition when it fails. It is similar to NSParameterAssert but not limited to checking the arguments.


ETAssertUnreachable

ETAssertUnreachable

Assertion macro to mark code portion that should never be reached. e.g. the default case in a switch statement.


FOREACH

FOREACH(collection, object, type)

Macro providing a foreach statement on collections, with IMP caching.

@param type An element type such as 'NSString *' to typecheck the messages sent to the elements in the code block.


FOREACHE

FOREACHE(collection, object, type, enumerator)

Macro providing a foreach statement on collections, with IMP caching.

@param collection Can be nil , this argument is ignored. @param type An element type such as 'NSString *' to typecheck the messages sent to the elements in the code block. @param enumerator A custom enumerator object to use to iterate over the collection.


FOREACHI

FOREACHI(collection, object)

Macro providing a foreach statement on collections, with IMP caching.

You should rather use FOREACH that provides basic typechecking.


INDEXSET

INDEXSET(...)

Shortcut macro to create a NSIndexSet.


INVALIDARG_EXCEPTION_TEST

INVALIDARG_EXCEPTION_TEST(arg, condition)

Exception macro to check whether the given argument respects a condition.
When the condition evaluates to NO, an NSInvalidArgumentException is raised.


LOCAL_AUTORELEASE_POOL

LOCAL_AUTORELEASE_POOL

Create a temporary autorelease pool that is destroyed when the scope exits.


LOCK_FOR_SCOPE

LOCK_FOR_SCOPE(x)

Macro that sends a -lock message to the argument immediately, and then an -unlock message when the variable goes out of scope (including if an exception causes this stack frame to be unwound).


NILARG_EXCEPTION_TEST

NILARG_EXCEPTION_TEST(arg)

Exception macro to check the given argument is not nil, otherwise an NSInvalidArgumentException is raised.


S

S(...)

Shortcut macro to create a NSSet. Same as +[NSSet setWithObjects:].


SELFINIT

SELFINIT

Deprecated. You should use the designated initializer rule. Simple macro for safely initialising the current class.


SUPERINIT

SUPERINIT

Simple macro for safely initialising the superclass.


Macros functions

ETDrainAutoreleasePool

void ETDrainAutoreleasePool(void* object);

Cleanup function that releases a lock.


ETStackAutoRelease

void ETStackAutoRelease(void* object);
Description forthcoming.

ETUnlockObject

void ETUnlockObject(void* object);

Cleanup function that releases a lock.