TweetFollow Us on Twitter

A simple debugging tool for Cocoa

Volume Number: 19 (2003)
Issue Number: 12
Column Tag: Programming

A simple debugging tool for Cocoa

Another weapon in the fight against bugs

by Steve Gehrman

Here's the problem: You write an application, test it, fix the bugs and everything works great while testing in-house. But, the moment you send it to the customer you get a ton of bug reports.

How could this be? You tested the code thoroughly, and you've been running the application for months throughout the development process. You're now getting bug reports you've never seen before. What happened?

The problem lies in the fact that it's just not possible for the developer or even a small team of in-house testers to uncover all the bugs no matter how hard they try. Software is just too complex, and there are just too many variations in machines, OS versions, and interactions with other installed software to catch everything.

So, what can you do? The only solution is to have your users help in the testing/debugging process. These users/testers are commonly referred to as beta testers. There's only one problem with this solution. Your beta testers aren't developers, and have no clue how the code works, so the bug reports you receive may not be easy to decipher or reproduce. What you really need is a fool proof way for a user to report a problem automatically with information in a form that helps the developer determine what went wrong.

In this article, I explain a simple technique for doing this. Using this technique, when a problem occurs in your application, a window will appear with information describing what happened, and a stack trace of where the problem occurred. There is also a button in the window to automatically email this information to the developer. That way, all the developer has to do is check their email, examine the reports, and fix the bugs. Sounds cool, right?

The key to this debugging tool is exceptions. Most Cocoa objects will throw an exception when passed a bad parameter or when something unexpected happens. Catching and displaying exception information is the key to this debugging aid. Catching exceptions can't find every type of software bug in your application, but it will uncover a surprising number of problems and uncover lots of trouble spots in your code. I've been using this code in my own application, "Path Finder," for two years now, and it has proven indespensible.

The remainder of this article explores the code used to do this and explains how it works. All the code is downloadable in a simple example application. If you're like me and like to see the working code before reading the rest of the article, download the example application here from the MacTech website at www.mactech.com/src/19.12.

The Code:

Cocoa has two built in classes for exception handling: NSException and NSExceptionHandler. These two classes are located in the ExceptionHandling.framework. The first step is to add this framework to your application. I'm using XCode, so to do this I go to the "Project" menu and choose "Add Frameworks..." and navigate to /System/Library/Frameworks/ and choose ExceptionHandling.framework.

Let's start by looking at the NSExceptionHandler class. NSExceptionHandler is really simple and does the work of telling us when an exception has occurred in our application. All we need to do is create a delegate object that will be sent a message when an exception occurs.

I created a class called NTExceptionHandlerDelegate to do this. Here's the code, it's very short.

@implementation NTExceptionHandlerDelegate
- (id)initWithEmail:(NSString*)emailAddress;
{
    self = [super init];
    
    _emailAddress = [emailAddress retain];
    
    [[NSExceptionHandler defaultExceptionHandler] setDelegate:self];
    [[NSExceptionHandler defaultExceptionHandler] setExceptionHandlingMask:
       NSLogAndHandleEveryExceptionMask];
    
    return self;
}
- (void)dealloc;
{
    [[NSExceptionHandler defaultExceptionHandler] setDelegate:nil];
    [_emailAddress release];
    [super dealloc];
}
// used to filter out some common harmless exceptions
- (BOOL)shouldDisplayException:(NSException *)exception;
{
    NSString* name = [exception name];
    NSString* reason = [exception reason];
    
    if ([name isEqualToString:@"NSImageCacheException"] ||
        [name isEqualToString:@"GIFReadingException"] ||
        [name isEqualToString:@"NSRTFException"] ||
        ([name isEqualToString:@"NSInternalInconsistencyException"] && [reason hasPrefix:
           @"lockFocus"])
        )
    {
        return NO;
    }
    
    return YES;
}
- (BOOL)exceptionHandler:(NSExceptionHandler *)sender shouldLogException:(NSException *)exception 
   mask:(unsigned int)aMask;
{
    // this controls whether the exception shows up in the console, just return YES
    return YES;
}
- (BOOL)exceptionHandler:(NSExceptionHandler *)sender shouldHandleException:(NSException *)exception 
   mask:(unsigned int)aMask;
{
    // if the exception isn't filtered by shouldDisplayException, display the information to the user
    if ([self shouldDisplayException:exception])
        [[NTExceptionPanelController alloc] initWithException:exception emailAddress:_emailAddress];
    
    return YES;
}
@end

For the init method of NTExceptionHandlerDelegate, I pass it an email address. This is the email address where you want to receive the exception reports. You need to allocate one of these objects somewhere in your code. In the sample application, I allocate it in +[MyDocument initialize]. If you run the sample application, be sure to change the email address so you will receive the emailed reports.

Next, I call two methods using the shared default NSExceptionHandler object:

[[NSExceptionHandler defaultExceptionHandler] setDelegate:self];
[[NSExceptionHandler defaultExceptionHandler] setExceptionHandlingMask: 
   NSLogAndHandleEveryExceptionMask];

The call to setDelegate sets this instance of NTExceptionHandlerDelegate as the NSExceptionHandler's delegate. The second call to setExceptionHandlingMask tells NSExceptionHandler which exceptions I'm interested in handling. I pass NSLogAndHandleEveryExceptionMask to tell it to send me every exception.

There were a few harmless exceptions that were happening frequently in Path Finder that I decided to filter out. That way my email box doesn't get full of emails that I've already determined to be OK. The exception filtering happens in the method shouldDisplayException. You may choose to remove or modify this code.

In order for the NTExceptionHandlerDelegate instance to receive the exceptions, it must implement two methods found in the informal protocol located in NSExceptionHandler.h.

@interface NSObject(NSExceptionHandlerDelegate)
- (BOOL)exceptionHandler:(NSExceptionHandler *)sender shouldLogException:
   (NSException *)exception mask:(unsigned int)aMask;   
- (BOOL)exceptionHandler:(NSExceptionHandler *)sender shouldHandleException:
   (NSException *)exception mask:(unsigned int)aMask;
@end

These are the messages sent by the NSExceptionHandler to the delegate when an exception occurs. In the code above you can see that in the method exceptionHandler:shouldLogException:, I just return YES. This tells the NSExceptionHandler to log the exception in the console. In the next method exceptionHandler:shouldHandleException:mask I call the code to display the exception to the user in a window. This is where the magic happens. This window is handled in by the NTExceptionPanelController class.

Let's look inside NTExceptionPanelController to see what it does.

- (id)initWithException:(NSException*)exception emailAddress:(NSString*)emailAddress;
{
    self = [super init];
    
    _displayFont = [[NSFont fontWithName:@"Monaco" size:10.0] retain];
    _emailAddress = [emailAddress retain];
    
    // load the nib
    if (![NSBundle loadNibNamed:@"NTExceptionPanel" owner:self])
    {
        NSLog(@"Failed to load NTExceptionPanel.nib");
        NSBeep();
    }
    else
    {
        [self displayCrashReport:exception];
        
        // center the window, show the window
        [window center];
        [window makeKeyAndOrderFront:nil];
    }
    
    return self;
}

The init call loads the nib containing the window, and if successful, calls [self displayCrashReport:exception]. The window loaded from the nib contains a single NSTextView. displayCrashReport's job is to fill that text view with the information extracted from the exception. NTExceptionPanelController has a simple helper method called displayText to write a string into the NSTextView.

Here's the code:

- (void)displayCrashReport:(NSException*)exception;
{
    NSMutableArray *args = [ NSMutableArray array ];
    NSString* appName = [self applicationName];
    NSString* stackTrace;
    
    // display instructions
    [self displayText:appName];
    [self displayText:[NSString stringWithFormat:@" has encountered an unexpected error.  
       Please email this report to %@ so it can be fixed in the next release.", _emailAddress]];
    [self displayText:@"\r\r"];
    
    // display version
    [self displayText:appName];
    [self displayText:@": "];
    [self displayText:[NTUtilities applicationVersion]];
    [self displayText:@"\r\r"];
    
    // display OS version
    [self displayText:[NTUtilities OSVersion]];
    [self displayText:@"\r\r"];
    
    [self displayText:[exception name]];
    [self displayText:@"\r\r"];
    [self displayText:[exception reason]];
    [self displayText:@"\r\r"];
    
    stackTrace = [[exception userInfo] objectForKey:NSStackTraceKey];
    if (stackTrace)
    {
        // add the process id
        [args addObject:@"-p"];
        [args addObject:[[self applicationProcessID] stringValue]];
        
        {
            // must add each stack trace as individual arguments
            NSScanner *scanner = [NSScanner scannerWithString:stackTrace];
            NSString* output;
            
            NSCharacterSet *whitespace = [NSCharacterSet whitespaceCharacterSet];
            
            while (YES)
            {
                if ([scanner scanUpToCharactersFromSet:whitespace intoString:&output])
                    [args addObject:output];
                else
                    break;
            }
        }
        
        _atosTask = [[NTTaskController alloc] initWithDelegate:self];
        [_atosTask runTask:NO toolPath:@"/usr/bin/atos" directory:@"/" withArgs:args];
    }
}

We start by displaying the application name and instructions to the user telling them what has occurred and what to do next. Next we display the version of the application, the version of the OS, the exception name, and the exception reason. Next is the stack trace. Inside the exeption userInfo dictionary is an NSString with the key NSStackTraceKey. This string looks something like this:

0x8c7a1f04  0x97e54804  0x97df1820  0x01e58aa0  0x930f9cac  0x9311a3ec  
0x9315e54c  0x930f36b8  0x9315e168  0x9312de6c  0x930c102c  0x930a8e20  0x930b1dac  
0x9315fc58  0x00117f74  0x000038e0  0x00003760  0x00001000

That isn't too useful. What we really need is for those numeric addresses to be converted into symbols. Fortunately, there is a built in unix command line tool that does this called "atos". Open the Terminal and type "man atos" for more information.

In order to run "atos" we first need convert the string of addresses in to an array of individual address strings. This is used as the parameter to "atos". atos takes this array of addresses and converts each one to a human readable symbol. In Cocoa this is easily accomplished using an NSTask. In this code I'm using a wrapper around NSTask called NSTaskController which makes running an NSTask even easier. Basically, it runs the task and sends us the output and takes care of all the details automatically. Next, the code takes the output and adds it to the windows NSTextView. Look at the documentation on NSTask and look at the code of NSTaskController to see how this works. It's very straightforward.

Here's some sample output from atos. Given the input string of: "0x8c7a1f04 0x97e54804 0x97df1820 0x01e58aa0 0x930f9cac 0x9311a3ec 0x9315e54c 0x930f36b8 0x9315e168 0x9312de6c 0x930c102c 0x930a8e20 0x930b1dac 0x9315fc58 0x00117f74 0x000038e0 0x00003760 0x00001000", we get this:

_NSExceptionHandlerExceptionRaiser (in ExceptionHandling)
+[NSException raise:format:] (in Foundation)
-[NSCFArray objectAtIndex:] (in Foundation)
-[MyDocument exception1Action:] (in MyDocument.ob) (MyDocument.m:72)
-[NSApplication sendAction:to:from:] (in AppKit)
-[NSControl sendAction:to:] (in AppKit)
-[NSCell _sendActionFrom:] (in AppKit)
-[NSCell trackMouse:inRect:ofView:untilMouseUp:] (in AppKit)
-[NSButtonCell trackMouse:inRect:ofView:untilMouseUp:] (in AppKit)
-[NSControl mouseDown:] (in AppKit)
-[NSWindow sendEvent:] (in AppKit)
-[NSApplication sendEvent:] (in AppKit)
-[NSApplication run] (in AppKit)
_NSApplicationMain (in AppKit)
_main (in main.ob) (main.m:13)
start (in ExceptionHandlerExample)
start (in ExceptionHandlerExample)
0x00001000 (in ExceptionHandlerExample)

That's a whole lot easier to understand than the string of addresses.

So, we are almost done. We have a window which contains all the information on the exception and a stack trace telling us exactly where the exception occurred. Now all we need to do is email this information to the developer.

Cocoa has a very simple interface for sending an email using the class NSMailDelivery. NSMailDelivery is part of the Message.framework, so you will need to add the Message.framework to your project. I'm using XCode, so to do this I go to the "Project" menu and choose "Add Frameworks..." and navigate to /System/Library/Frameworks/ and choose Message.framework.

- (void)emailAction:(id)sender;
{
    BOOL mailSent=NO;
    NSString *subject = [NSString stringWithFormat:@"%@ exception report", [self applicationName]];
    mailSent = [NSMailDelivery deliverMessage:[textView string] subject:subject to:_emailAddress];
    if (!mailSent)
        NSBeep();  // you may want to handle the error
    
    [window close];
}

The email button in the window is set to send the action emailAction. In email action I construct a string for the message subject and use the contents of the NSTextView as the email body. Sending the email requires just one line of code:

mailSent = [NSMailDelivery deliverMessage:[textView string] 
subject:subject to:_emailAddress];

Summary:

So, that's all there is too it. Add this to your application, send it out to beta testers and get back accurate reports of trouble spots in your code. This debugging tool doesn't catch all types of bugs. There are many types programming errors that don't throw exceptions and therefore won't be detected by this system, but it is one more powerful tool in your arsenal against bugs.


Steve Gehrman is the founder and lead developer at CocoaTech. Feel free to contact Steve at steve@cocoatech.com.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Latest Forum Discussions

See All

Top Mobile Game Discounts
Every day, we pick out a curated list of the best mobile discounts on the App Store and post them here. This list won't be comprehensive, but it every game on it is recommended. Feel free to check out the coverage we did on them in the links... | Read more »
Price of Glory unleashes its 1.4 Alpha u...
As much as we all probably dislike Maths as a subject, we do have to hand it to geometry for giving us the good old Hexgrid, home of some of the best strategy games. One such example, Price of Glory, has dropped its 1.4 Alpha update, stocked full... | Read more »
The SLC 2025 kicks off this month to cro...
Ever since the Solo Leveling: Arise Championship 2025 was announced, I have been looking forward to it. The promotional clip they released a month or two back showed crowds going absolutely nuts for the previous competitions, so imagine the... | Read more »
Dive into some early Magicpunk fun as Cr...
Excellent news for fans of steampunk and magic; the Precursor Test for Magicpunk MMORPG Crystal of Atlan opens today. This rather fancy way of saying beta test will remain open until March 5th and is available for PC - boo - and Android devices -... | Read more »
Prepare to get your mind melted as Evang...
If you are a fan of sci-fi shooters and incredibly weird, mind-bending anime series, then you are in for a treat, as Goddess of Victory: Nikke is gearing up for its second collaboration with Evangelion. We were also treated to an upcoming... | Read more »
Square Enix gives with one hand and slap...
We have something of a mixed bag coming over from Square Enix HQ today. Two of their mobile games are revelling in life with new events keeping them alive, whilst another has been thrown onto the ever-growing discard pile Square is building. I... | Read more »
Let the world burn as you have some fest...
It is time to leave the world burning once again as you take a much-needed break from that whole “hero” lark and enjoy some celebrations in Genshin Impact. Version 5.4, Moonlight Amidst Dreams, will see you in Inazuma to attend the Mikawa Flower... | Read more »
Full Moon Over the Abyssal Sea lands on...
Aether Gazer has announced its latest major update, and it is one of the loveliest event names I have ever heard. Full Moon Over the Abyssal Sea is an amazing name, and it comes loaded with two side stories, a new S-grade Modifier, and some fancy... | Read more »
Open your own eatery for all the forest...
Very important question; when you read the title Zoo Restaurant, do you also immediately think of running a restaurant in which you cook Zoo animals as the course? I will just assume yes. Anyway, come June 23rd we will all be able to start up our... | Read more »
Crystal of Atlan opens registration for...
Nuverse was prominently featured in the last month for all the wrong reasons with the USA TikTok debacle, but now it is putting all that behind it and preparing for the Crystal of Atlan beta test. Taking place between February 18th and March 5th,... | Read more »

Price Scanner via MacPrices.net

AT&T is offering a 65% discount on the ne...
AT&T is offering the new iPhone 16e for up to 65% off their monthly finance fee with 36-months of service. No trade-in is required. Discount is applied via monthly bill credits over the 36 month... Read more
Use this code to get a free iPhone 13 at Visi...
For a limited time, use code SWEETDEAL to get a free 128GB iPhone 13 Visible, Verizon’s low-cost wireless cell service, Visible. Deal is valid when you purchase the Visible+ annual plan. Free... Read more
M4 Mac minis on sale for $50-$80 off MSRP at...
B&H Photo has M4 Mac minis in stock and on sale right now for $50 to $80 off Apple’s MSRP, each including free 1-2 day shipping to most US addresses: – M4 Mac mini (16GB/256GB): $549, $50 off... Read more
Buy an iPhone 16 at Boost Mobile and get one...
Boost Mobile, an MVNO using AT&T and T-Mobile’s networks, is offering one year of free Unlimited service with the purchase of any iPhone 16. Purchase the iPhone at standard MSRP, and then choose... Read more
Get an iPhone 15 for only $299 at Boost Mobil...
Boost Mobile, an MVNO using AT&T and T-Mobile’s networks, is offering the 128GB iPhone 15 for $299.99 including service with their Unlimited Premium plan (50GB of premium data, $60/month), or $20... Read more
Unreal Mobile is offering $100 off any new iP...
Unreal Mobile, an MVNO using AT&T and T-Mobile’s networks, is offering a $100 discount on any new iPhone with service. This includes new iPhone 16 models as well as iPhone 15, 14, 13, and SE... Read more
Apple drops prices on clearance iPhone 14 mod...
With today’s introduction of the new iPhone 16e, Apple has discontinued the iPhone 14, 14 Pro, and SE. In response, Apple has dropped prices on unlocked, Certified Refurbished, iPhone 14 models to a... Read more
B&H has 16-inch M4 Max MacBook Pros on sa...
B&H Photo is offering a $360-$410 discount on new 16-inch MacBook Pros with M4 Max CPUs right now. B&H offers free 1-2 day shipping to most US addresses: – 16″ M4 Max MacBook Pro (36GB/1TB/... Read more
Amazon is offering a $100 discount on the M4...
Amazon has the M4 Pro Mac mini discounted $100 off MSRP right now. Shipping is free. Their price is the lowest currently available for this popular mini: – Mac mini M4 Pro (24GB/512GB): $1299, $100... Read more
B&H continues to offer $150-$220 discount...
B&H Photo has 14-inch M4 MacBook Pros on sale for $150-$220 off MSRP. B&H offers free 1-2 day shipping to most US addresses: – 14″ M4 MacBook Pro (16GB/512GB): $1449, $150 off MSRP – 14″ M4... Read more

Jobs Board

All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.