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

How to become the ultimate robot warrior...
Chrono Strike is a delightfully immersive beat ‘em up with a sense of humor (any game with a good Sims reference gets points in my book). [Read more] | Read more »
Tips and tricks to get a higher score in...
Snow Roll is a devilish endless runner very much in the vein of Flappy Bird. It revels in its dastardly level of difficulty, and doesn’t really care how angry you get at it as it knows you’ll keep coming back for more. [Read more] | Read more »
How to win big in Slots Deluxe
Cheating while gambling is illegal and morally wrong, and in some parts of the world it leads to men with names like Vinnie "Six Knuckles" Manchenzo beating you to a pulp in a dark alley. [Read more] | Read more »
How to take over the world in Dictator 2
Running a country isn't easy - especially when you're a dictator who wants to take over the world and crush everyone in your path while you do it. [Read more] | Read more »
Tips and tricks to get a higher score in...
Tank.iois - you guessed it! - another multiplayer arena battler likeAgar.io and Slither.io. It does differentiate itself by putting you in a tiny tank though, so it's not exactly the same. To help you get that all-important high score, we've got a... | Read more »
How to unlock characters in One Tap Tenn...
As the title suggests, One Tap Tennis requires only a single tap to play its particular brand of tennis, and rewards you with a ton of unlockable characters if you perform well. Fortunately for you, we at 148Apps have got a few tips and tricks to... | Read more »
Grab it now: Game Craft’s Legend of War...
The real time strategy game is now available for you to sink your teeth into, through the App Store and Google Play. Combining elements of skill, strategy and empire building, Legend of War is a real gamers’ game. [Read more] | Read more »
Skateboard Party 3 ft. Greg Lutzka (Gam...
Skateboard Party 3 ft. Greg Lutzka 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Skateboard Party is back! This third edition of the popular sports franchise features professional skater... | Read more »
Cubious (Games)
Cubious 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: Cubious – How smart are you? How high is your IQube? Solve the impossible puzzles to find out, and help a lost little cube find his... | Read more »
Goat Simulator Waste of Space (Games)
Goat Simulator Waste of Space 1.1 Device: iOS Universal Category: Games Price: $4.99, Version: 1.1 (iTunes) Description: ** IMPORTANT - SUPPORTED DEVICESiPhone 4S, iPad 2, iPod Touch 5 or better.** | Read more »

Price Scanner via MacPrices.net

12-inch 1.2GHz Space Gray Retina MacBook avai...
Amazon has the new 12″ 1.2GHz/512GB Space Gray Retina MacBook (Apple model #MLH82LL/A) available for $1549 including free shipping. Their price is $50 off MSRP. B&H has the 12″ 1.2GHz/512GB Space... Read more
Apple refurbished Mac Pros available for up t...
Apple has Certified Refurbished Mac Pros available for up to $600 off the cost of new models. An Apple one-year warranty is included with each Mac Pro, and shipping is free. The following... Read more
Enterprise Workers Pick Technology Over Perks...
New Adobe study shows surprising attitudes about office jobs and where the future of work is heading. Adobe has released survey findings revealing that a surprising 70 percent of U.S. office workers... Read more
Memorial Day Weekend Sale: $50-$100 off 11-in...
B&H Photo has 13″ and 11″ MacBook Airs with 256GB SSDs on sale for $50-$100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 11″ 1.6GHz/256GB MacBook Air: $999 $100 off MSRP... Read more
Memorial Day Weekend Sales: Apple MacBook Pro...
B&H Photo has 13″ and 15″ Retina MacBook Pros on sale for up to $210 off MSRP. Shipping is free, and B&H charges NY tax only: - 15″ 2.2GHz Retina MacBook Pro: $1799 $200 off MSRP - 15″ 2.5GHz... Read more
Memorial Day Weekend Sales: Apple iMacs and M...
Take up to $150 off the price of a new iMac or Mac mini at the following Apple resellers this Memorial Day weekend: iMacs: B&H Photo has 21″ and 27″ iMacs on sale for up to $150 off MSRP... Read more
Apple refurbished Retina MacBook Pros availab...
Apple has Certified Refurbished 2015 13″ and 15″ Retina MacBook Pros available for up to $380 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free... Read more
Apple refurbished 11-inch MacBook Airs availa...
Apple has Certified Refurbished 11″ MacBook Airs (the latest models), available for up to $170 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is... Read more
Goal Zero and OtterBox Partner to Expand iPh...
Goal Zero, specialists in portable power, have announced a partnership with OtterBox, brand smartphone case protection, to offer the Slide and Slide Plus Batteries as modules compatible with the new... Read more
15-inch Retina MacBook Pros on sale for up to...
B&H Photo has 15″ Retina MacBook Pros on sale for up to $210 off MSRP. Shipping is free, and B&H charges NY tax only: - 15″ 2.2GHz Retina MacBook Pro: $1799 $200 off MSRP - 15″ 2.5GHz Retina... Read more

Jobs Board

*Apple* Project Engineer - Smart Source Inc...
SmartSource is in need of an Apple Project Engineer for a 12 month contract opportunity in Pittsburg, PA. Role: Apple Project Engineer Location: Pittsburg, PA Read more
Senior *Apple* Engineer - Signature Technol...
One-year contract for an Apple consultant. The resource should be an Apple Certified Technical Coordinator or get the certification within 60 days of starting Read more
Senior *Apple* Engineer - Signature Technol...
One-year contract for an Apple consultant. The resource should be an Apple Certified Technical Coordinator or get the certification within 60 days of starting Read more
*Apple* Architect - AECOM (United States)
**Requisition/Vacancy No.** 132759BR **Position Title** Apple Architect **Job Category** Information Technology **Business Line** Government **Country** United Read more
*Apple* Solutions Consultant - APPLE (United...
Job Summary As an Apple Solutions Consultant, you'll be the link between our future customers and our products. You'll showcase your entrepreneurial spirit as you Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.