Home > Articles > Programming > General Programming/Other Languages

iOS Development: A Fistful of Directive Tricks

  • Print
  • + Share This
Although many compiler directives exist in the Xcode wild, many developers rarely move past #define (to create macros) or #pragma mark (to add bookmarks). There’s so much more you can do. Compiler directives are language add-ons that specify how Xcode processes its input. Xcode’s Clang compiler offers a rich suite of possibilities. This quick write-up offers a few of these directives, and you learn how they can enable you to harness warnings and errors for the greatest information impact.
Like this article? We recommend

Converting Comments to Warnings

I first encountered this clever Build Phase trick about a year ago. It enables developers to convert common to-do items prefixes to automatically built compiler warnings via regular expression matching. When you build your app, a shell script matches any occurrence of TODO:, FIXME:, ???, or ///, automatically inserting a #warning directive so that these items show up as compile-time issues, as shown in Figure 1.

Figure 1 A build phase script converts comments to warnings

The great advantage of this is that it automatically centralizes project status items to your Xcode issue navigator, where you can inspect an overview throughout your project. Warnings and errors are listed on a file-by-file basis, so you can keep track of open issues you still need to address, as shown in Figure 2.

Figure 2 The issue navigator collects the converted warnings

It takes just a few steps to implement this effect.

  1. Customize your project by adding a build phase. Select Editor > Add Build Phase > Add Run Script Build Phase.
  2. Open the Run Script section and locate the section that says “Type a script or drag a script file from your workspace to insert its path,” as shown in Figure 3.

Figure 3 A run script build phase enables you to script changes to your build

  1. Paste in the following script. If you want, edit the |-delimited keywords list to customize it to your particular documentation needs.
  2. KEYWORDS="TODO:|FIXME:|\?\?\?:|\!\!\!:" find "${SRCROOT}" \( -name "*.h" -or
    -name "*.m" \) -print0 | xargs -0 egrep --with-filename --line-number --only-
    matching "($KEYWORDS).*\$" | perl -p -e "s/($KEYWORDS)/ warning: \$1/"
  3. Compile. Your //TODO:, //FIXME:, //!!!:, and //???: comments automatically upgrade to warnings, enabling you to track to-do items throughout your project from a single navigator.

Warnings

If you’d rather not tie yourself to specific comment patterns like the ones you just read about, consider using the Clang #warning directive directly. The following sequence tests for an iOS compilation target and generates a warning accordingly, as shown in Figure 4.

#if TARGET_OS_IPHONE
#warning This class is not meant for iOS deployment
#endif

Figure 4 The #warning directive produces a compiler warning. When working with deployment mismatches, you may want to escalate this to an error

This next example uses a target test, too. I’ve been writing a lot of cross-platform code recently for constraint utilities. Because TARGET_OS_MAC returns true for both iOS and OS X targets, you’ll always want to test for TARGET_OS_IPHONE instead.

#ifndef  COMPATIBILITY_ALIASES_DEFINED
#if TARGET_OS_IPHONE
    @compatibility_alias View UIView;
    @compatibility_alias Color UIColor;
#else
    @compatibility_alias View NSView;
    @compatibility_alias Color NSColor;
#endif
#endif
#define COMPATIBILITY_ALIASES_DEFINED

The @compatibility_alias keyword used in this example enables you to map an alias (like View or Color to platform-specific classes (like UIView or NSView, or UIColor or NSColor). Guarding this code with the definition declaration ensures that these aliases are defined just once in the project, avoiding compilation errors.

Errors

The #error directive works in a similar fashion to the #warning one. The following example checks that a required include file was added in the project. It produces a compiler error if it’s missing.

#if !__has_include("Utility-Compatibility.h")
#error ERROR! Required Cross Compatibility include file not found!
#endif

On compile, the error produces a red-circled exclamation point error feedback instead of the yellow triangle, as shown in Figure 5. Use this directive when you detect inconsistent compilation conditions (for example, missing include files) or unsupported compiler targets (for example, when you know a class will not compile properly for iOS or OS X).

Figure 5 Error directives produce a red-colored fatal error

Messages

Message pragmas are directives that, as their name suggests, produce messages. They won’t convert to an error regardless of compiler settings. Here’s an example of a message that reminds you about some to-do item.

#pragma message ("To Do: Extend this to include Feature A")

Like #warning and #error directives, messages show up in your issues navigator and with inline highlighting, as shown in Figure 6. However, they are informational only. The compiler basically ignores them, even when you’ve switched on “Treat Errors as Warnings.”

Figure 6 The Issue navigator aggregates compilation warnings and errors

Wrapping Pragmas

Diagnostic messages can themselves be wrapped into macros to produce standardized output. This is a handy trick, one that enables you to wrap message requests into reusable components. Here are a couple macros that combine to create To Do items.

#define DO_PRAGMA(_ARG_) _Pragma (#_ARG_)
#define TODO(_ITEM_) DO_PRAGMA(message ("To Do: " #_ITEM_))

When you invoke the TODO macro, it builds the same results as the message directive you just saw. It supplies a message argument to the _Pragma operator and adds the "To Do: " prefix into the message it builds.

TODO(Extend this to include Feature A)

If you want, you can incorporate standard compiler-supplied macros like __FILE__, __LINE__, __DATE__, and __TIME__ with message directives. For example, you might add the following message (see Figure 7), which uses the __FILE__ macro to an implementation file.

#pragma  message "Compiling" __FILE__

Figure 7 Compiler-supplied macros provide information about the items being processed

Overriding Diagnostics

You override diagnostics with the diagnostic ignored pragma. The following example temporarily disables warnings about undeclared selectors and their leaks. By surrounding these items with push and pop directives, you localize those overrides to just this section. The compiler continues to tag undeclared selector usage in the rest of your project.

#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wundeclared-selector"
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
void SafePerform(id target, SEL selector, NSObject *object)
{
    if ([target respondsToSelector:selector])
        [target performSelector:selector withObject:object];
}
#pragma clang diagnostic pop

Unused Variable Warnings

Unused variable warnings often crop up in development. They provide a good example of how you can solve a problem using any number of directives (see Figure 8).

Figure 8 Compiler-supplied macros provide information about the items being processed

As with selector issues, you can use a “diagnostic ignored” pragma like the following to suppress the compiler warning.

#pragma clang diagnostic ignored "-Wunused-variable"

Or you can mark the variable with an attribute.

NSString *description __attribute__ ((unused));

Or use the __unused keyword.

NSInteger __unused index;

There’s also a specific unused pragma available:

#pragma unused (description)

You can also wrap this pragma into its own macro if you’re so inclined.

// Create "unused" macro
#define UNUSED(_ITEM_) DO_PRAGMA(unused(_ITEM_))

// Use the macro in-line with the declaration
NSString *description; UNUSED(description);

Wrap-Up

This little overview presented a number of ways you can add or suppress diagnostic messages in Xcode projects. These represent just a subset of the range of compiler customizations you can use to take charge of your projects. Whether you’re enhancing visibility of your workflow To Do items or hiding warnings for items that don’t actually concern you, Xcode and Clang provide you with sophisticated tools that adapt to your individual development style.

  • + Share This
  • 🔖 Save To Your Account

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