I'm trying to complete the puzzle.
__strong
is the default for all Objective-C retainable object pointers like NSObject, NSString, etc.. It's a strong reference. ARC balances it with a -release
at the end of the scope.
__unsafe_unretained
equals the old way. It's used for a weak pointer without retaining the retainable object.
__weak
is like __unsafe_unretained
except that it's an auto-zeroing weak reference meaning that the pointer will be set to nil as soon as the referenced object is deallocated. This eliminates the danger of dangling pointers and EXC_BAD_ACCESS errors.
But what exactly is __autoreleasing
good for? I'm having a hard time finding practical examples on when I need to use this qualifier. I believe it's only for functions and methods which expect a pointer-pointer such as:
- (BOOL)save:(NSError**);
or
NSError *error = nil;
[database save:&error];
which under ARC has to be declared this way:
- (BOOL)save:(NSError* __autoreleasing *);
But this is too vague and I'd like to fully understand why. The code snippets I find place the __autoreleasing inbetween the two stars, which looks weird to me. The type is NSError**
(a pointer-pointer to NSError), so why place __autoreleasing
inbetween the stars and not simply in front of NSError**
?
Also, there might be other situations in which I must rely on __autoreleasing
.
You're right. As the official documentation explains:
__autoreleasing to denote arguments that are passed by reference (id *) and are autoreleased on return.
All of this is very well explained in the ARC transition guide.
In your NSError example, the declaration means __strong
, implicitly:
NSError * e = nil;
Will be transformed to:
NSError * __strong error = nil;
When you call your save
method:
- ( BOOL )save: ( NSError * __autoreleasing * );
The compiler will then have to create a temporary variable, set at __autoreleasing
. So:
NSError * error = nil;
[ database save: &error ];
Will be transformed to:
NSError * __strong error = nil;
NSError * __autoreleasing tmpError = error;
[ database save: &tmpError ];
error = tmpError;
You may avoid this by declaring the error object as __autoreleasing
, directly.
Following up on Macmade's answer and Proud Member's follow up question in the comments, (would have also posted this as a comment but it exceeds the max character count):
Here is why the variable qualifier of __autoreleasing is placed between the two stars.
To preface, the correct syntax for declaring an object pointer with a qualifier is:
NSError * __qualifier someError;
The compiler will forgive this:
__qualifier NSError *someError;
but it isn't correct. See the Apple ARC transition guide (read the section that begins "You should decorate variables correctly...").
To address to the question at hand: A double pointer cannot have an ARC memory management qualifier because a pointer that points to a memory address is a pointer to a primitive type, not a pointer to an object. However, when you declare a double pointer, ARC does want to know what the memory management rules are for the second pointer. That's why double pointer variables are specified as:
SomeClass * __qualifier *someVariable;
So in the case of a method argument that is a double NSError pointer, the data type is declared as:
- (BOOL)save:(NSError* __autoreleasing *)errorPointer;
which in English says "pointer to an __autoreleasing NSError object pointer".
The definitive ARC specification says that
For __autoreleasing objects, the new pointer is retained, autoreleased, and stored into the lvalue using primitive semantics.
So for example, the code
NSError* __autoreleasing error = someError;
actually gets converted to
NSError* error = [[someError retain] autorelease];
... which is why it works when you have a parameter NSError* __autoreleasing * errorPointer
, the called method will then assign the error to *errorPointer
and the above semantics will kick in.
You could use __autoreleasing
in a different context to force an ARC object into the autorelease pool, but that's not terribly useful since ARC only seems to use the autorelease pool at method return and already handles that automatically.
To be short: this is only for compatibility with MRC.
Apple have made agreement that in own libraries objects returned by **
are always autoreleased. So ARC
code will work fine with old binaries (for example if you have deployment target iOS 4) and vise versa MRC
code will work fine with ARC
binaries.
So in conclusion:
You should never use __autoreleasing: compiler will automatically add it where needed
If you are not going to support MRC code, then you should use * __strong * everywhere. It will save from crashes of family: @autoreleasingpool { *autorelesingOut = [@"crash maker" mutableCopy];//NSString * __autoreleasing *autorelesingOut; *strongOut = [@"it's ok" mutableCopy];//NSString * __strong *strongOut; //App will crash if autorelesingOut will be referenced outside of this autoreleasepool }
Success story sharing
__autoreleasing
is only used for arguments passed by reference. This is a special case, as you've got a pointer to an object's pointer. That's not the case with stuff like convenience constructors, as they only returns a pointer to an object, and as ARC handles it automatically.