Home > Articles > Mobile Application Development & Programming

Blocks to Basics in Objective-C

Blocks are one of the most fundamentally useful iOS technologies. If you're not pushing beyond system-supplied APIs and incorporating them into your day-to-day development, you're missing out on one of the most powerful Objective-C features. Discover some basic block how-tos and pick up a few tricks for your projects.
Like this article? We recommend

Blocks are one of the most fundamentally useful iOS technologies. You pass blocks to methods and functions as arguments so that they can be stored and executed at later times. Blocks enable you to move those implementation details away from isolated callbacks and into the actual context where they're most meaningful. This approach improves readability and inspection because the way items react before, during, and after some process are most relevant at the point where that process is defined.

First introduced in iOS 4, blocks create functional closures. Closures are objects that encapsulate both behaviors and state. Unlike method selectors and function pointers, blocks carry that state with them for when they're executed. This enables you to refer to variables defined in the parent's lexical scope from within the block itself. That means you don't have to pass massive numbers of parameters to blocks to keep them in sync. Block parameters instead reflect information that won't be available until the block is executed. This is crazy convenient, ensuring that any relevant state can be used exactly when it's needed.

Most iOS developers now regularly use blocks in their projects (see Figure 1) using system-supplied and custom APIs but there's often confusion as to exact implementation details. Various sites have sprung up to provide quick block syntax references including at least one with an honest but not-safe-for-work name. (It offers a more workplace friendly URL as well.) These sites reflect the fussy detail reality associated with block declaration and use.

Figure 1 In modern iOS development, we are all blockheads (Image courtesy of LiveAuctioneers)

I personally ended up writing an entire OS X application (see Figure 2) because while I love blocks to death, I can never quite remember exactly how to phrase them in code. I'll know I want to build a completion block, for example, that takes a success argument or a testing block that returns a Boolean value, but the minutia always is just one neuron beyond my working memory. My BlockItToMe utility (available on my website) helps avoid that pain.

Figure 2 To avoid blocking on how to declare and use blocks, I wrote a utility to create a boilerplate

Auto Complete Is Your Friend

For many developers, a first exposure to blocks involves system-supplied APIs such as view animation. Xcode's autocomplete system, shown in Figure 3 (top), provides placeholder tokens for each argument. These are coded with a blue highlight. When you double-click any token, Xcode automatically expands it to further detail. For example, after expanding the completion parameter, Xcode creates the more detailed ready-to-use block outline you find in Figure 3's bottom screen shot.

Figure 3 You don't have to remember how to construct block parameters because Xcode builds them for you

This same auto complete convenience applies to any method you build into your classes. In Figure 4, the block argument token expands into a block that uses strings for both its argument and return type. You'll never have to remember how to structure a method or function argument because Xcode takes care of that on your behalf.

Figure 4 Xcode block-expanding autocomplete isn't just for system-supplied APIs

Define Block Types

Block typedefs are incredibly useful. For example, say you're building a class whose instances performs an action and, when finished, permit you to execute an optional completion block. You can go the standard route and specify a full block argument declaration like this:

- (void) performWithCompletion: (void (^)(BOOL finished)) completionBlock;

Alternatively you simplify matters by declaring a custom block type in your class header file. Here's an example that defines a type and then uses it in a method signature identical to the example you just saw.

typedef void (^MyCustomCompletionBlock)(BOOL finished);
- (void) performWithCompletion: (MyCustomCompletionBlock) completionBlock;

With typedefs, you inherit the same Xcode auto complete features as you do with explicit block declarations. At the same time you increase code readability, and there's only one point where you have to worry about the fine details of how to specify the block type. The declaration consists of a return type followed by a type name and concludes with a parameter list. Include a caret (^) before your type name and use both sets of parentheses.

typedef <#return type#>(^<#type name#>)(<#parameter list#>);

Build Typed Block Variables

When you've defined a block type, you can declare and assign variables using that type. For example, you might use the custom completion block type you just saw to create an instance variable.

MyCustomCompletionBlock completion = ^(BOOL finished){
    NSLog(@"completed");
};

You can then use that block as an argument, for example:

[self performWithCompletion:completion];

But what do you do when working with system-supplied APIs that don't use typedefs? If your custom type is equivalent to an argument, you may use your typed argument. For example, MyCustomCompletionBlock is identical to the completion argument used in UIView's animation call.

+ (void)animateWithDuration:(NSTimeInterval)duration animations:(void (^)(void))animations completion:(void (^)(BOOL finished))completion

This enables you to pass the completion variable defined above to this animation method. In this example, when the animation concludes, the completion block logs "completed".

[UIView animateWithDuration:0.5f animations:^{
        self.view.backgroundColor = [UIColor clearColor];
    } completion:completion];

Declaring Block Variables

You're not required to use a typedef, of course, to assign block to variables. Use the following format to declare a block variable. Start with a return type followed by the variable name and a parameter list. You'll need a caret (^) before the variable name and two sets of parentheses.

<#return type#> (^<#variable name#>)(<#parameter list#>)

With that in mind, the following example declares a completion block, identical to the one you just saw, but without using custom typedefs.

void (^completion)(BOOL) = ^(BOOL finished){
        NSLog(@"completed");
    };

Use Block Properties

At times you may want to use properties instead of method arguments to hold onto blocks until you're ready to use them. The property declaration mirrors the form you use for creating local variables.

@property (nonatomic, copy) MyCustomCompletionBlock finished;

or

@property (nonatomic, copy) void (^completion)(BOOL finished);

Make sure you use the method accessor to ensure the property's copy attribute is applied. That is, use this

self.completion = ^(BOOL finished){
    NSLog(@"completed");
}

rather than this.

_completion = ^(BOOL finished){
    NSLog(@"completed");
}

Block Safety

With blocks, safety matters. If there's any chance a property has not been set or a parameter might be nil, make sure you test for the block before attempting to execute it. Here's an example of what that might look like.

if (self.completion) 
    self.completion(status);

And Figure 5 shows an example of what happens if you forget that step.

Figure 5 Executing unassigned blocks crashes your application

Executing a nil block will crash your application so consider using one of the following approaches to add further safety to your apps.

  • Nonnull attributes. When you declare parameters using a nonnull attribute, Xcode raises a warning if you pass nil. (See Figure 6)
- (void) foo: (ABlockType) blockParameter __attribute__ ((nonnull))
{
    //....
}
  • Parameter assertions. The NSParameterAssert function tests whether a parameter is nil and raises an NSInternalInconsistencyException exception if it is.
- (void) foo: (ABlockType) blockParameter
{
    // blockParameter must not be nil
    NSParameterAssert(blockParameter);
}

Figure 6 The nonnull attribute tells the compiler to warn when a required parameter is null

Wrap Up

You just got a short taste of some ways you can expand your use of blocks in iOS development. Here are a few key points to keep with you.

  • If you're not using typedefs with your blocks, you're missing out on one of the best solutions for simplifying your code.
  • Emulate Apple and consider adapting classes to use completion blocks. Properties enable your instances to hold onto those until they're ready to use them.
  • Don't forget to stop by any of the blocks quick reference sites mentioned in this write-up. They, plus my BlockItToMe utility, can help you get your block syntax just right.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020