iOS 5 Twitter Framework & completionHandler block - "Capturing 'self' strongly in this block is likely to lead to a retain cycle"

Question

I am very new to programming and Objective-C and I am trying to work out what is wrong with my code. I have read a bit about blocks but I don't know how any of what I have read so far is relevant to my code.

My code is using the iOS 5 Twitter Framework. I use most of the sample code that Apple provides so I actually had no clue at first that I was using a block for the completion handler.

Now I get those two messages from Xcode 4 saying "1. Block will be retained by an object strongly retained by the captured object" and "Capturing 'self' strongly in this block is likely to lead to a retain cycle".

Basically, what I did is to remove the code Apple used in their completion handler (switch statement with TWTweetComposeViewControllerResultCancelled & TWTweetComposeViewControllerResultDone) and used my if statements with [imagePickerController sourceType].

So the sendTweet gets called after an image has been added to the tweet.

I hope someone can explain to me why this is happening and how I can solve it. Also: can I put the completion handler code into a method instead of a block?

- (void)sendTweet:(UIImage *)image
{
    //adds photo to tweet
    [tweetViewController addImage:image];

    // Create the completion handler block.
    //Xcode: "1. Block will be retained by an object strongly retained by the captured object"
    [tweetViewController setCompletionHandler:
                             ^(TWTweetComposeViewControllerResult result) {
            NSString *alertTitle,
                     *alertMessage,
                     *otherAlertButtonTitle,
                     *alertCancelButtonTitle;

            if (result == TWTweetComposeViewControllerResultCancelled) 
            {
                //Xcode: "Capturing 'self' strongly in this block is likely to lead to a retain cycle"
                if ([imagePickerController sourceType])
                {
                    alertTitle = NSLocalizedString(@"TCA_TITLE", nil);
                    alertMessage = NSLocalizedString(@"TCA_MESSAGE", nil);
                    alertCancelButtonTitle = NSLocalizedString(@"NO", nil);
                    otherAlertButtonTitle = NSLocalizedString(@"YES", nil);

                    //user taps YES
                    UIAlertView *alert = [[UIAlertView alloc] 
                                             initWithTitle:alertTitle 
                                                   message:alertMessage 
                                                  delegate:self   // Note: self
                                         cancelButtonTitle:alertCancelButtonTitle 
                                         otherButtonTitles:otherAlertButtonTitle,nil];
                    alert.tag = 1;
                    [alert show];                
                }            
            }

score 21 · Accepted Answer · edited May 23 '17 at 12:22

21

The basic problem is that you're using self within a block. The block is being retained by the object and the block itself retains the object, too. So you have a retain-cycle and thus both will probably never be released because both have a reference pointing towards them. Fortunaly there is a simple workaround:

By using a so-called weak reference to self the block will no longer retain the object. The object then can later be released which will release the block (set MyClass to the appropriate type):

// before your block
__weak MyObject *weakSelf = self;

Inside your block you now can use weakSelf instead of self. Note that this is only for iOS 5 using ARC.

Looking at this there is also a very good long explanation on How do I avoid capturing self in blocks when implementing an API? which also describes how to avoid this on iOS 4 and without ARC.

edited May 23 '17 at 12:22

Community

1
1

answered Nov 16 '11 at 22:20

Dennis Bliefernicht

5,147
1
28
24

Thanks for your help! Since I am a total beginner I had problem figuring out how to really implement this. In the end I used __weak UIImagePickerController *weakSelf = imagePickerController; and change my if statement to if([weakSelf sourceType]). Xcode 4 isn't showing me any errors anymore so I suppose I did the right thing. (?) – iMaddin Nov 16 '11 at 23:46
+1 @Dennis thanks for answer. Please also explain when "__block" is used. Example i have syntax like __block HomeViewController *weakSelf = self; – HDdeveloper Feb 21 '13 at 06:40

score 3 · Answer 2 · answered Nov 16 '11 at 22:22

3

Your block is retaining self because you're using self as the delegate of the UIAlertView. If self is also retaining the block, they're retaining each other, which creates a retain cycle.

Try

 __block WhateverTypeSelfIs *nonRetainedSelfForBlock = self;
[tweetViewController setCompletionHandler:

and

UIAlertView *alert = [[UIAlertView alloc] 
                                 initWithTitle:alertTitle 
                                 message:alertMessage 
                                 delegate:nonRetainedSelfForBlock 
                                 cancelButtonTitle:alertCancelButtonTitle 
                                 otherButtonTitles:otherAlertButtonTitle,nil];

Check the Apple docs, section Object and Block Variables. Objects referenced within a block are retained, unless you use __block.

answered Nov 16 '11 at 22:22

Terry Wilcox

9,010
1
34
36

Thanks for pointing out that something was wrong with my UIAlertView in the block. Since I am using ARC I think Xcode told me that I cannot use __block. I used __weak instead as TriPhoenix mentioned and it worked great. Thanks! – iMaddin Nov 16 '11 at 23:50
+1 @Terry Wilcox, Please explain difference between "__block" and "__weak". Thanks – HDdeveloper Feb 21 '13 at 06:44
@HDdeveloper http://stackoverflow.com/questions/11773342/what-the-difference-between-weak-and-block-reference – Terry Wilcox Feb 21 '13 at 16:30

score 1 · Answer 3 · answered May 24 '12 at 14:24

According to stuff I've seen elsewhere, “weak” won't work for ARC-compliant code, and that you must use “_unsafe_unretained” instead. This is what I did to fix the “Capturing 'self' strongly in this block is likely to lead to a retain cycle” warning in the Apple sample app "AVPlayerDemo":

__unsafe_unretained id unself = self;
mTimeObserver = [mPlayer addPeriodicTimeObserverForInterval:CMTimeMakeWithSeconds(interval, NSEC_PER_SEC) 
                            queue:NULL /* If you pass NULL, the main queue is used. */
                            usingBlock:^(CMTime time) 
                                        {
                                            /* 'unself' replaced 'self' here: */
                                            [unself syncScrubber];
                                        }];

score 0 · Answer 4 · answered Mar 03 '12 at 13:57

There is a rather surprising way to get rid of the warning. Mind you, only do this if you are sure you are not creating a retain cycle, or you are sure that you will break it yourself later on (by setting the completion handler to nil when you're done, for example). If you have control over the interface, then rename your method so it does not start with "set". The compiler seems to give this warning only when the method name starts with "set".

iOS 5 Twitter Framework & completionHandler block - "Capturing 'self' strongly in this block is likely to lead to a retain cycle"

4 Answers4

Linked