TweetFollow Us on Twitter

Jun 02 Cocoa

Volume Number: 18 (2002)
Issue Number: 06
Column Tag: Cocoa Development

by Dan Wood, Alameda CA

The Beauty of Categories

Use This Objective-C Feature to Make Your Cocoa Code Cleaner

Ask any experienced Cocoa programmer what they like the most about Objective-C and the answer will invariably be “categories.” Categories is one of the features of Objective-C, not found in Java or C++, that raises the body temperature of developers if you suggest they use another language.

What is It, and Why Use It?

A category is an extension of an existing class. But unlike inheritance, in which you create a new class that descends from another class, a category is like a remora, attaching itself to the belly of a shark and getting a free ride. By creating a category, you add new methods to an existing class, without needing to create a new one.

Writing in a language without categories, the programmer is often faced with the need to perform minor operations, acting upon an object for which source code is unavailable. These routines might end up as methods in the application class that needs to perform those operations, although that doesn’t promote reuseability, since the operations are tied in with the enclosing class. A better approach, one more commonly used, is to collect these operations into a utility class.

On an open-source web application framework that I worked on, called Janx (available at www.bearriver.com) there is a string utilities class, for example. This class has operations to parse strings representing dollars and cents, encode a string for HTML display, generate a hexadecimal representation, build an MD5 digest from a string, and so forth. Each of these methods takes a string to operate upon as one of its parameters.

This “utility class” approach isn’t particularly elegant either. Dissimilar operations tend to be grouped together into the same class. Each method must be passed in the object to operated upon as a parameter, which means that the functions that you write look and operate differently from methods that are part of the class, even if they perform similar operations.

Another approach to extending functionality is to create a subclass of an existing framework object, and add your new functionality into the subclass. For instance, you might subclass an existing “image” class to add operations. The problem is that you must now be sure to work only with instances of your new class; any objects that aren’t must be converted.

If you are programming in a language such as C++ or Java without categories, though, you just deal with these limitations; they may not seem like limitations at all.

When you write an application in Cocoa using Objective C, you have the ability to put such functions directly into an existing class by creating a category on that class. No, you don’t recompile the class with new methods in the file; in fact you usually don’t have the source code to the class you are adding to.

Utilities vs. Categories

Let’s take a look at how this might be done by implementing a utility function to strip quote marks off of a string. (We’ll implement them both in Objective-C just to keep the playing field level.) We implement it as a method in a string utility class in listing 1 and 2; we implement it as a category on NSString in listing 3 and 4.

Listing 1: StringUtilities.h

#import 
@interface StringUtilities
+ (NSString *) stripQuotes:(NSString *)inString;
@end

Listing 2: StringUtilities.m

#import "StringUtilities.h"
@implementation StringUtilities

+ (NSString *) stripQuotes:(NSString *)inString
{
   NSString *result = inString;      // Return inString if no stripping needed
   int len = [inString length];
   if (len >= 2
      && '"' == [inString characterAtIndex:0]
      && '"' == [inString characterAtIndex:len-1])
   {
      // Get the substring that doesn’t include first and last character
      result =
         [inString substringWithRange:NSMakeRange(1,len-2)];
   }
   return result;
}

Listing 3: NSString+misc.h

#import 
@interface NSString ( misc )
- (NSString *) stripQuotes;
@end

Listing 4: NSString+misc.m

#import "NSString+misc.h"
@implementation NSString ( misc )

- (NSString *) stripQuotes
{
   NSString *result = self;      // Return self if no stripping needed
   int len = [self length];
   if (len >= 2
      && '"' == [self characterAtIndex:0]
      && '"' == [self characterAtIndex:len-1])
   {
      // Get the substring that doesn’t include first and last character
      result = [self substringWithRange:NSMakeRange(1,len-2)];
   }
   return result;
}

The implementations of these category looks much like the utility class; the main difference is that the string to operate upon is not passed in as a parameter; it is accessed with the self keyword. Things start to look different when you compare code that uses the category instead of a utility class. Here are snippets that use each approach.

Snippet using a utility class

   NSString *stripped =
      [StringUtilities stripQuotes:theValue];
   [lineDict setObject:stripped
      forKey:[theKey uppercaseString]];

Snippet using a category

   NSString *stripped =
      [theValue stripQuotes];
   [lineDict setObject:stripped
      forKey:[theKey uppercaseString]];

The code using the category is quite a bit cleaner because we don’t have to be conscious of a separate utility class; it is just another operation on the string, just like the built-in uppercaseString method on the last line.

Writing Categories

A category must have an @interface and @implementation section, just as a class. After the name of the class being added to is an arbitrary name which describes what the category is for, in parentheses. The example above uses "misc" as its name.

Normally, a category on a class gets its own “.h” and “.m” file; a convention is to name the file based on the class name concatenated with “+” to the category name. For example, the file NSImage+bitmap.m would be expected to hold @implementation NSImage ( bitmap ). This is not strictly neccesary; however; you could make a quick category interface and implementation right in your class file that makes use of the category; this would only be practical if it was not needed outside of the associated class.

Methods are declared and implemented just as they would be for any standard Objective-C’s methods. Keep in mind, however that self is the class that you are implementing; feel free to send messages to self to operate on that object.

The one big limitation on categories is that you can only add functionality; you cannot add new data members to the class. There are no curly braces in the @interface section of a category. If you feel the need to add data members, you may want to consider subclassing instead.

Using Categories

The best thing about categories is that you can add whatever features to Cocoa you’d like to that you feel are “missing.” Frustrated that NSImage lacks the +[NSImage imageFromData:] method? Add it in yourself! You can write generic categories and use them on all your projects, and make use of them as if you were using functionality of the classes provided by Apple. Or, you can create categories on an object as needed, whenever it seems more intuitive to extend the functionality of a Cocoa class rather than write a function to act upon that object.

You can even use categories on your own code, to help factor your application’s classes into smaller, more manageable chunks. For instance, you might create separate categories to partition your document controller into preferences management, window management, and general functionality. Doing so makes your files smaller and makes your project more navigable. Cocoa itself makes heavy use of categories in this manner; it allows classes to be created in one library (such as Foundation Kit) and then extended in another (such as Application Kit).

One of the best places to use a category is to split up your class’s private methods from its public ones, to overcome a limitation in Objective-C. Unlike C++ and Java, there’s no way to specify the access of a method using keywords. So the solution is to create a new @interface for your category at the top of your class’s “.m” file, holding the methods you do not want to be exposed in the “.h” file. This category would have a name such as “private” to indicate its purpose. Below that, the @implementation section of your class can then hold the implementation of both the public methods (declared in the “.h” file) and the private methods (declared in your private category). Other classes will not be able to see your private methods.

Usually, you will find yourself adding categories to classes in the Foundation Kit, because this kit tends to hold containers and utilities. You can even add categories to NSObject so that any object can respond to your new functionality. When there is a technique that requires bridging into Carbon or Core Foundation to accomplish your task, you could wrap it into a category on a related class (or even find one online that somebody else has already written) , so that if such functionality were to make its way into a future version of Cocoa, your code wouldn’t have to change much.

Examples

Where you make use of categories is limited only by your imagination. It is useful to look at other people’s source code just to get a sense of what kinds of categories are possible. Many source code packages are available for downloading at softrak.stepwise.com.

Here are a few examples that I have used in my own code. To make use of these, you would need to create @interface and @implementation sections following the guidelines above.

Category for NSImage

A method to set an image size to be the size of its associated NSBitmapImageRepresentation so that the image displays at full size of 72 DPI. It finds the first bitmap it can, and sets the size of the bitmap and of the image to the pixel width and height.

- (NSImage *) normalizeSize
{
   NSBitmapImageRep   *theBitmap = nil;
   NSArray               *reps = [self representations];
   NSSize                  newSize;
   int                     i;
   
   for (i = 0 ; i < [reps count] ; i++ )
   {
      NSImageRep *theRep = [reps objectAtIndex:i]; 
      if ([theRep isKindOfClass:[NSBitmapImageRep class]])
      {
         theBitmap = (NSBitmapImageRep *)theRep;
         break;
      }
   }
   if (nil != theBitmap)      // Found a bitmap to resize
   {
      newSize.width = [theBitmap pixelsWide];
      newSize.height = [theBitmap pixelsHigh];
      [theBitmap setSize:newSize];      // resize bitmap
      [self setSize:newSize];            // resize image
   }
   return self;
}

Category for NSBundle, NSDictionary, NSString, etc.

A comparison method (passing in another object of the same) so that you can sort an array of those objects by some property, using -[NSMutableArray sortUsingSelector:]. For example, you could sort an array of dictionaries by the value of their “name” key by passing in the selector for the following method.

- (NSComparisonResult) compareSymbolName:
      (NSDictionary *) inDict
{
   NSString *myName = [self objectForKey:@"name"];
   NSString *otherName = [inDict objectForKey:@"name"];
   return [myName caseInsensitiveCompare:otherName];
}

Category for NSString

A method to return an attributed string as a blue underlined hyperlink, so that text fields can respond to link clicks as in a web browser. Text in an NSTextView with these attributes will send the message of textView: clickedOnLink: atIndex: to the view’s delegate.

- (NSAttributedString *)hyperlink
{
   NSDictionary *attributes=
      [NSDictionary dictionaryWithObjectsAndKeys:
         [NSNumber numberWithInt:NSSingleUnderlineStyle],
            NSUnderlineStyleAttributeName,
         self, NSLinkAttributeName,            // link to the string itself
         [NSFont systemFontOfSize:[NSFont smallSystemFontSize]],
            NSFontAttributeName,
         [NSColor blueColor], NSForegroundColorAttributeName,
         nil];
   NSAttributedString *result= 
      [[[NSAttributedString alloc]
         initWithString:self
         attributes:attributes] autorelease];
   return result;
}

Category for NSWorkspace

A method to return the path of the current user’s temporary directory. This makes use of the Carbon FindFolder() API, and then converts the C string into an NSString.

- (NSString *) temporaryDirectory
{
   char         s[1024];
   FSSpec      spec;
   FSRef      ref;
   short      vRefNum;
   long         dirID;
   
   if ( FindFolder(
      kOnAppropriateDisk, kChewableItemsFolderType, true,
         &vRefNum, &dirID ) == noErr )
   {
      FSMakeFSSpec( vRefNum, dirID, "", &spec );
      if ( FSpMakeFSRef(&spec, &ref) == noErr )
      {
         FSRefMakePath(&ref, s, sizeof(s));
         return [NSString stringWithCString:s];
      }
   }
   return nil;
}

Category for NSSet, NSArray, etc.

A method to build a string listing the strings in a collection, separated by commas. It enumerates through all objects in the structure, adding each string and then adding a comma. It then removes the extra comma (and space) at the end, after the list is traversed.

- (NSString *) show
{
   NSString               *result = @"";      // empty string if none in collection
   NSMutableString      *buffer = [NSMutableString string];
   NSEnumerator         *theEnum = [self objectEnumerator];
   NSString               *theIdentifier;

   while (nil != (theIdentifier = [theEnum nextObject]) )
   {
      [buffer appendString:theIdentifier];
      [buffer appendString:@", "];
   }
   // Delete final comma+space from the string
   if (![buffer isEqualToString:@""])
   {
      [buffer deleteCharactersInRange:NSMakeRange(
         [buffer length]-2, 2)];
      result = [NSString stringWithString:buffer];
   }
   return result;
}

Conclusion

Hopefully you have been convinced that categories are a useful construct for programming in Cocoa. If you’re not using Objective-C, you can certainly function without them. But if you are, then categories are a great way to make your code more readable, more reuseable, more maintainable, and simpler.


Dan Wood wrote Watson for Mac OS X, a Cocoa application that connects to a variety of Web services. You can reach him at dwood@karelia.com.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

BBEdit 11.0.3 - Powerful text and HTML e...
BBEdit is the leading professional HTML and text editor for the Mac. Specifically crafted in response to the needs of Web authors and software developers, this award-winning product provides a... Read more
Microsoft Office Preview 15.8 - Popular...
Welcome to the new and modern Microsoft Office for Mac. You will receive regular updates automatically until the official release in the second half of 2015. With the redesigned Ribbon and your... Read more
Yosemite Cache Cleaner 9.0.5 - Clear cac...
Yosemite Cache Cleaner is an award-winning general purpose tool for OS X. YCC makes system maintenance simple with an easy point-and-click interface to many OS X functions. Novice and expert users... Read more
ExpanDrive 4.3.2 - Access cloud storage...
ExpanDrive builds cloud storage in every application, acts just like a USB drive plugged into your Mac. With ExpanDrive, you can securely access any remote file server directly from the Finder or... Read more
RapidWeaver 6.0.8 - Create template-base...
RapidWeaver is a next-generation Web design application to help you easily create professional-looking Web sites in minutes. No knowledge of complex code is required, RapidWeaver will take care of... Read more
Artlantis Studio 5.1.2.7 - 3D rendering...
Artlantis Studio is a unique and ideal tool for performing very high resolution rendering easily and in real time. The new FastRadiosity engine now lets you compute images in radiosity-even in... Read more
MacUpdate Desktop 6.0.5 - Search and ins...
MacUpdate Desktop 6 brings seamless 1-click installs and version updates to your Mac. With a free MacUpdate account and MacUpdate Desktop 6, Mac users can now install almost any Mac app on macupdate.... Read more
BitTorrent Sync 2.0.82 - Sync files secu...
BitTorrent Sync allows you to sync unlimited files between your own devices, or share a folder with friends and family to automatically sync anything. File transfers are encrypted. Your information... Read more
Google Drive 1.20 - File backup and shar...
Google Drive is a place where you can create, share, collaborate, and keep all of your stuff. Whether you're working with a friend on a joint research project, planning a wedding with your fiancé, or... Read more
Simon 4.0.3 - Monitor changes and crashe...
Simon monitors websites and alerts you of crashes and changes. Select pages to monitor, choose your alert options, and customize your settings. Simon does the rest. Keep a watchful eye on your... Read more

New Publisher Allstar Games Heads West w...
Allstar Games has announced its first mobile title designed for western audiences, Allstar Heroes. The game will be a massive online battle arena (MOBA) that offers dozens of heroes for you to collect and pit against your opponents. As each hero has... | Read more »
RAD Boarding Review
RAD Boarding Review By Jennifer Allen on March 5th, 2015 Our Rating: :: NEARLY RADUniversal App - Designed for iPhone and iPad RAD Boarding isn’t quite one of the greats, but it has potential.   | Read more »
Presenting the International Mobile Gami...
11th Annual International Mobile Gaming Awards ceremony, hosted by actress Allison Haislip, gathered mobile game developers and publishers from around the world. They chose 13 winners out of the 93 nominations. British studio USTWO won the the Grand... | Read more »
AG Drive Review
AG Drive Review By Tre Lawrence on March 5th, 2015 Our Rating: :: FUTURISTIC STREET RACING.Universal App - Designed for iPhone and iPad Futuristic racing… interstellar style.   | Read more »
GDC 2015 – Nightmare Guardians is an Int...
GDC 2015 – Nightmare Guardians is an Interesting Hybrid of MOBA and Lane Defense Posted by Rob Rich on March 5th, 2015 [ permalink ] I have to say that lane defense (i.e. | Read more »
Overkill 3 Review
Overkill 3 Review By Tre Lawrence on March 5th, 2015 Our Rating: :: WHO'S NEXT?Universal App - Designed for iPhone and iPad Cover system gameplay in the third-person.   Developer: Craneballs Price: Free Version Reviewed: 1.1.6... | Read more »
Warner Bros. Interactive Entertainment A...
Warner Bros. has some exciting games coming down the pipe! | Read more »
GDC 2015 – Star Trek Timelines will Prob...
GDC 2015 – Star Trek Timelines will Probably Make Your Inner Trekkie Squeal With Glee Posted by Rob Rich on March 4th, 2015 [ permalink ] Any popular fictional universe has its fair share of fan fiction – where belo | Read more »
Protect Yourself from an Onslaught of Ca...
Surprise Attack Games has announced a Cat-astrophic new physics puzzler called Fort Meow! In the game, a young girl named Nia finds her grandfather’s journal which triggers an all mighty feline attack! Why do the cats want the journal? Who knows,... | Read more »
GDC 2015 – Jelly Reef will be Game Oven’...
GDC 2015 – Jelly Reef will be Game Oven’s Last Hurrah, and it Seems like a Good Note to Go Out on Posted by Rob Rich on March 4th, 2015 [ permalink ] It’s sad knowing that Game Oven ( | Read more »

Price Scanner via MacPrices.net

Roundup of MacBook Air sale prices, models up...
B&H Photo has MacBook Airs on sale for up to $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 11″ 128GB MacBook Air: $799 100 off MSRP - 11″ 256GB MacBook Air: $999 $100... Read more
New Firstrade Mobile App Enables On-The-Go Tr...
Firstrade Securities Inc. has announced its new mobile app, which gives investors immediate access to the company’s trading platform on all mobile devices. The app was developed in-house and was... Read more
Sonnet Introduces USB 3.0 + eSATA Thunderbolt...
Sonnet has announced the launch of its new USB 3.0 + eSATA Thunderbolt Adapter for easy connectivity to USB 3.0 devices and eSATA storage, and USB 3.0 + Gigabit Ethernet Thunderbolt Adapter for easy... Read more
Apple restocks refurbished 27-inch 5K iMacs f...
The Apple Store has restocked Apple Certified Refurbished 27″ 3.5GHz 5K iMacs for $2119 including free shipping. Their price is $380 off the cost of new models, and it’s the lowest price available... Read more
Free Clean Reader Mobile App Hides Swear Word...
The new Clean Reader app, now available in the Apple App Store and Google Play, delivers the opportunity of reading any book without being exposed to profanity. By selecting how clean they want their... Read more
Kinsa Launches “Groups” App to Monitor Illnes...
Kinsa, makers of the first FDA approved app-enabled smartphone thermometer thst won the 2013 Cleveland Clinic Medical Innovation Grand Prize and recently appeared in Apple’s “Parenthood” TV... Read more
iPad: A More Positive Outlook – The ‘Book Mys...
It’s good to hear someone saying positive things about the iPad. I’ve been trying to bend my mind around how Apple’s tablet could have gone from zero to bestselling personal computing device on the... Read more
Mac Pros on sale for up to $279 off MSRP
Amazon has Mac Pros in stock and on sale for up to $279 off MSRP. Shipping is free: - 4-Core Mac Pro: $2725.87, $273 off MSRP (9%) - 6-Core Mac Pro: $3719.99, $279 off MSRP (7%) Read more
Sale! 13-inch Retina MacBook Pros for up to $...
B&H Photo has 13″ Retina MacBook Pros on sale for up to $205 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.6GHz/128GB Retina MacBook Pro: $1219.99 save $80 - 13″ 2.... Read more
Another Tranche Of IBM MobileFirst For iOS Ap...
IBM has announced the next expansion phase for  its IBM MobileFirst for iOS portfolio, with a troika of new apps to address key priorities for the Banking and Financial Services, Airline and Retail... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
Position Opening at *Apple* - Apple (United...
…Summary** As a Specialist, you help create the energy and excitement around Apple products, providing the right solutions and getting products into customers' hands. You Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** The Apple Store is a retail environment like no other - uniquely focused on delivering amazing customer experiences. As an Expert, you introduce people Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.