TweetFollow Us on Twitter

Safe Haquery Volume Number: 17 (2001)
Issue Number: 2
Column Tag: Mac OS X

The Art of Safe Haquery, Categorically Speaking

By Andrew Stone

The Subtitle in Italics

The Cocoa newcomer is constantly barraged with enthusiasm and praise of the Cocoa APIs by the early Cocoa adopters. These lofty feelings are indeed merited by the powerful and easy to use Cocoa development environment. Although Cocoa comes in both Java and Objective-C flavors, it's Objective-C which shines for ease of adding new functionality to existing classes through the Objective-C language mechanism known as Categories. This article will show you how to add and change functionality of an existing Cocoa class, the NSSavePanel, by using a category, a subclass and a tool which reveals all the methods in a class, classdump.

First, I must explain the spelling of haque and haquery, and how that came to be. In the field of Computer Science, we lovingly refer to the art of clever programming as hacking. But alas, the free press (albeit, controlled by only 5 men) has taken to using the term "hacker" for people engaged in unlawful computer cracking. Take back our term! By adding a slightly continental twist, voilà, le haque!

Before we embark on how to go below the API to accomplish tasks unaccomplishable through normal means, I am required by the unwritten laws of the unformed guild of responsible programmers to give my short lecture on using undocumented, unexposed API: Don't do it - you'll regret it - your program will break in a future release. The lecture always sounds better in the positive: if you strictly adhere to the Cocoa API, then not only will your application continue to function in future releases, it will actually run better as the dynamically loaded frameworks it depends on receive bug fixes from Apple.

That said, when you've decided that the only way to obtain behavior you desire is by using undocumented API, you need to make that code as safe as possible by assuming that the Apple implementation will change underneath you. We'll go over the tricks and tips when we look at the code below.

First, I wanted the ability to let the user create a new directory in a preset folder. I wanted to reuse the NSSavePanel because it knows how to get the name of a new directory and run as a sheet, Cocoa style. But the SavePanel is designed to allow the user to browse the directory structure and I don't want to allow that. When the SavePanel is in its "minimum" state with the File browser hidden, it's almost perfect for my needs. By disabling both the "reveal the browser" button and the Favorites popup, the panel is perfect for my needs:


Figure 1. This save panel has been tweaked to allow the user to create a new folder in the current folder only - there is no way for the user to navigate to other folders.

Unfortunately, there is no API to make the SavePanel not display the browser, New Folder button, Favorites popup, and other interface items which allow the user to leave the directory explicitly set by the program. So - how the heck can one programmatically shrink up the save panel? The best place to start looking is inside the NSSavePanel.nib file - which lives in /System/Library/Frameworks/AppKit.framework/Resources/English.lproj. Double-click that file to launch InterfaceBuilder.

We notice that the UI objects we need to mess with have outlets in the NSSavePanel class:

  • _favoritesPopup is the popup we need to disable
  • _expandButton is the button which makes the browser come and go

We also note that the expandButton's target is the SavePanel, and its action is: _expandPanel:. Right away, the leading underscore tips us off that this is an undocumented method. We do not want to call this directly; its name may change. Here's the trick: simply ask the expandButton to performClick:! That way, should Apple change the method which that button sends, our code will still work correctly. We are only in trouble if they remove _expandButton or change its name. Further safety could be had by noting the tag of the _expandButton in InterfaceBuilder, and using NSView's "viewWithTag" to find the button - thus never referring to the button by name. However, the creator of the nib file didn't assign a tag to either the expand button or the favorites popup, so that technique is useless here. You could also do a recursive search of the panel's contentView's subviews for a view of class NSPopUpButton to find the _favoritesPopup, but that would break if Apple added another popup to the panel.

Now, open the header file for NSSavePanel, found in:

/System/Library/Frameworks/AppKit.framework//Headers/NSSavePanel.h

You'll see the whole API - but here's what's interesting for us:

@interface NSSavePanel : NSPanel
{
    /*All instance variables are private*/
// Apple is telling you NOT TO RELY ON ANYTHING HERE!

    NSBrowser      *_browser;
    ...
    id                  _expandButton;
    ...
    id                  _favoritesPopup;
    ...
    struct __spFlags {
    ...
        unsigned int       collapsed:1;
    ...
    }                   _spFlags;
    ...
}

So, it looks like there is a way to determine if the panel is collapsed (_spFlags.collapsed), and we can disable the favorites button (_favoritesPopup) as well as ask the expandButton (_expandButton) to pretend the user clicked it.

We'll write a simple method to use in our application which checks the collapsed state of the panel, collapses it if it is expanded, and disables the folder navigation buttons. Because we're adding functionality and don't need to change any existing NSSavePanel methods, we'll use a category.

A category looks similar to class implementations, except:

  1. a category name comes after the class name
  2. no new instance variables can be declared

Here's our interface declaration:

@interface NSSavePanel(SuperTrickyStuff)
- (void)prepareToDisplayOnlyName;
@end

So a client of our SavePanel, who wants the collapsed version, will use calling code similar to this:

- (IBAction)newGalleryAction:(id)sender {

  // save panel configured for only creating new folders in the current one
  // Because we mess with this panel, we want our own copy so this doesn't
  // affect normal save panels used in the rest of the application:

    static NSSavePanel *savepanel = nil;
    if (!savepanel) {
        // If the save panel is to be reused, you must retain it!
        savepanel = [[NSSavePanel savePanel]retain];
    }
   // establish the folder where you want users to create a new folder:
   // note how subclasses could redefine where the saveDirectory is:
    [savepanel setDirectory:[self saveDirectory]];

   // Make the savepanel not require a filetype
   //  (directories don't require a path extension)
    [savepanel setRequiredFileType:@""];
    
    // Here's our invocation of our new category method
    // see explanation below as to why we use performSelector:withObject:afterDelay:
    [savepanel performSelector:@selector(prepareToDisplayOnlyName) withObject:nil afterDelay:.01];

   // following the Cocoa model of running save sheets, use NSSavePanel's
   // new API to run the save panel window modally:
   // This establishes the callback method, delegate, and context information
  // for use when, and if, the user ever finishes running the save panel:

    [savepanel beginSheetForDirectory:[self saveDirectory] file:@""
modalForWindow:[_controller window] modalDelegate:self
didEndSelector:@selector(didEndGallerySheet:returnCode:contextInfo:) contextInfo:NULL];

}

The only tricky part about calling our new category method is that we want it to happen AFTER the window has already come up on screen. And since the call to beginSheetForDirectory:file:modalForWindow:modalDelegate:didEndSelector: returns immediately, we need to schedule our call to prepareToDisplayOnlyName to occur AFTER the sheet appears on the window. Ideally you would do it before the window comes up so the user won't see the window collapse before her eyes - but it turns out that the Save panel does its own setting of the collapsed state if the user last collapsed another Save panel in the application. Once the save panel is displayed, then the programmatic "clicking" of the expand button will work correctly. NSObject defines a method, performSelector:withObject:afterDelay: for times when you need to schedule a call to happen after the current event loop goes around. If I tried to collapse it too early, it would further collapse and disappear!

Our implemenation of our Save panel category is also very straighforward - 8 lines of code:

@implementation NSSavePanel(SuperTrickyStuff)

// the user must be unable to use the Favorites popup 
// and the expand button, so we disable them:

- (void)disableButtons {
   [_favoritesPopup setEnabled:NO];
   [_expandButton setEnabled:NO];
}

// we temporarily enable the expand button just so we can send it the method
// performClick:

- (void)collapse:(id)sender {
   [_expandButton setEnabled:YES];
   [_expandButton performClick:nil];
   [self disableButtons];
}

// this is the only method we expose - and 
// all you need to call to set up the panel:

- (void)prepareToDisplayOnlyName {
    if (!_spFlags.collapsed) {
        [self collapse:nil];
    } else [self disableButtons];  
   // if it's already collapsed, we want the buttons disabled
}

Note that we need to call this every time we run the panel, because if the user sets another SavePanel into full file browser mode, the next time we run our save panel, it will once again try to set itself to the expanded state because of the inner workings of the NSSavePanel.

My next SavePanel challenge arose when the behavior of NSSavePanel changed for the worse in Public Beta. Now, when you go to save a file, all existing files are "disabled" and dimmed, so it's very hard to overwrite an existing file - you have to painstakingly and correctly type the exact name of the preexisting file. It used to be that you could simply double-click an existing file to save over it, and that behavior is what we want to restore to the panel. When outputting HTML, users may tweak something and then want to output the new version to a preexisting directory, essentially writing over the previous files. Since users complained about the apparent inability to write over old files, I decided it was time to peer deeper into the API.


Figure 2. This save panel has been tweaked to allow the user to select existing files - normally, they are disabled and unselectable.

After finding no available API to do what I wanted, I approached this by researching the private methods of NSSavePanel to try and deduce how this enabling/disabling was occurring. A piece of perennial software that has been companion to NeXTStep and OpenStep developers for years is now available for Cocoa: class-dump. This command line tool takes advantage of the Objective-C runtime to spit out all the instance and class methods in a program, bundle or framework. My friends at www.stepwise.com have a version via SoftTrak updated for OS X by James McIlrae: http://www.stepwise.com/SoftTrak/ and search for "class-dump". Once again, let me repeat that any developer who uses undocumented API deserves the headaches thus incurred! By using class-dump on the AppKit framework and searching for NSSavePanel, I found two methods that seemed extremely related to what I was trying to do:

- _itemHit:fp12;
- (BOOL)_enableLeaf:(id)fp12 container:(id)fp16 {

Moreover, from the nib file, I learned that the filename field is actually an NSForm. I also guessed correctly that the browser sends the method _itemHit: to the NSSavePanel when you click an item in the browser. To do what we want to do, we need to change _itemHit. Because we have absolutely no idea what the original implementation of _itemHit: is, we need to be able to call the original implementation. Because of this, we can't use a category, which would hide the original implementation. Instead, we create a subclass of NSSavePanel, SaveOverPanel, which allows us to call super's implementation to get the real work done, and then afterwards, monkey with the UI to obtain the behavior we desire.

How can we be safe in this instance? First off, our implementation is totally passive. By passive, I mean we are not assuming that NSSavePanel will respond to any undocumented method. Instead, if and only if the NSSavePanel calls _itemHit:, we call super to let the panel do the work. If Apple takes out this method, our subclass's implementation will not get called. Moreover, we'll test each of our UI elements to see if they are still the same class using isKindOfClass:. If their class changes, our code will simply call super's implementation. So all we really need to do is return YES for whether any particular node is enabled, and then when a user clicks on an item, transfer that string to the filename field.

// define a subclass of NSSavePanel with no new instance variables:
@interface SaveOverPanel : NSSavePanel

@end

// reveal the secret method so the compiler will not complain:
@interface NSSavePanel(superSecret)
- _itemHit:fp12;
@end

// the few lines of code needed to do what we want:

@implementation SaveOverPanel

- (BOOL)_enableLeaf:(id)fp12 container:(id)fp16 {
   // we want every cell to be enabled:
   // should Apple take out this method, then it will never be called
   // and our program continues to work, but without our new functionality
   return YES;
}

// the NSBrowser is the sender:
- _itemHit:fp12 {
    // first be absolutely sure we know what kinds of objects we think we have:
    if ([fp12 isKindOfClass:[NSBrowser class]] && [_form isKindOfClass:[NSForm class]]) {
        NSBrowserCell *cell = [fp12 selectedCell];

        // by calling super, we insure any internal work is done right:
        id returnValue = [super _itemHit:fp12];

        // if we have a leaf node, ie file, transfer that to filename field:
        if ([cell isLeaf]) [[_form cellAtIndex:0] setStringValue:[cell stringValue]];

        // return what we got back from super, whatever it is ;-) :
        return returnValue;
    } else return [super _itemHit:fp12];
}

@end

To use this type of Savepanel, just include the new class when you create the panel:

- (IBAction)createWebPagesAction:(id)sender {
        static SaveOverPanel * savepanel = nil;
        if (!savepanel)  {
            savepanel = [[SaveOverPanel savePanel]retain];
        }
        ...
}

Conclusion

There are many good programming practices, but using undocumented API is not one of them! However, if your users demand certain functionality and no exposed API exists for that functionality, you might want to tread this dangerous ground. If you apply certain preventative techniques to your haquery, you can minimize side effects and future problems.


Andrew Stone, <andrew@stone.com>, is Chief Executive Haquer of Stone Design Corp - a New Mexican software house in its 13th year of producing Cocoa software.

 
AAPL
$102.50
Apple Inc.
+0.25
MSFT
$45.43
Microsoft Corpora
+0.55
GOOG
$571.60
Google Inc.
+2.40

MacTech Search:
Community Search:

Software Updates via MacUpdate

VueScan 9.4.41 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
Cloud 3.0.0 - File sharing from your men...
Cloud is simple file sharing for the Mac. Drag a file from your Mac to the CloudApp icon in the menubar and we take care of the rest. A link to the file will automatically be copied to your clipboard... Read more
LibreOffice 4.3.1.2 - Free Open Source o...
LibreOffice is an office suite (word processor, spreadsheet, presentations, drawing tool) compatible with other major office suites. The Document Foundation is coordinating development and... Read more
SlingPlayer Plugin 3.3.20.505 - Browser...
SlingPlayer is the screen interface software that works hand-in-hand with the hardware inside the Slingbox to make your TV viewing experience just like that at home. It features an array of... Read more
Get Lyrical 3.8 - Auto-magically adds ly...
Get Lyrical auto-magically add lyrics to songs in iTunes. You can choose either a selection of tracks, or the current track. Or turn on "Active Tagging" to get lyrics for songs as you play them.... Read more
Viber 4.2.2 - Send messages and make cal...
Viber lets you send free messages and make free calls to other Viber users, on any device and network, in any country! Viber syncs your contacts, messages and call history with your mobile device,... Read more
Cocktail 7.6 - General maintenance and o...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
LaunchBar 6.1 - Powerful file/URL/email...
LaunchBar is an award-winning productivity utility that offers an amazingly intuitive and efficient way to search and access any kind of information stored on your computer or on the Web. It provides... Read more
Maya 2015 - Professional 3D modeling and...
Maya is an award-winning software and powerful, integrated 3D modeling, animation, visual effects, and rendering solution. Because Maya is based on an open architecture, all your work can be scripted... Read more
BBEdit 10.5.12 - Powerful text and HTML...
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

Latest Forum Discussions

See All

Qube Kingdom – Tips, Tricks, Strategies,...
Qube Kingdom is a tower defense game from DeNA. You rally your troops – magicians, archers, knights, barbarians, and others – and fight against an evil menace looking to dominate your kingdom of tiny squares. Planning a war isn’t easy, so here are a... | Read more »
Qube Kingdom Review
Qube Kingdom Review By Nadia Oxford on August 29th, 2014 Our Rating: :: KIND OF A SQUARE KINGDOMUniversal App - Designed for iPhone and iPad Qube Kingdom has cute visuals, but it’s a pretty basic tower defense game at heart.   | Read more »
Fire in the Hole Review
Fire in the Hole Review By Rob Thomas on August 29th, 2014 Our Rating: :: WALK THE PLANKUniversal App - Designed for iPhone and iPad Seafoam’s Fire in the Hole looks like a bright, 8-bit throwback, but there’s not enough booty to... | Read more »
Alien Creeps TD is Now Available Worldwi...
Alien Creeps TD is Now Available Worldwide Posted by Ellis Spice on August 29th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Dodo Master Review
Dodo Master Review By Jordan Minor on August 29th, 2014 Our Rating: :: NEST EGGiPad Only App - Designed for the iPad Dodo Master is tough but fair, and that’s what makes it a joy to play.   | Read more »
Motorsport Manager Review
Motorsport Manager Review By Lee Hamlet on August 29th, 2014 Our Rating: :: MARVELOUS MANAGEMENTUniversal App - Designed for iPhone and iPad Despite its depth and sense of tactical freedom, Motorsport Manager is one of the most... | Read more »
Motorsport Manager – Beginner Tips, Tric...
The world of Motorsport management can be an unforgiving and merciless one, so to help with some of the stress that comes with running a successful race team, here are a few hints and tips to leave your opponents in the dust. | Read more »
CalPal Update Brings the App to 2.0, Add...
CalPal Update Brings the App to 2.0, Adds Lots of New Stuff Posted by Ellis Spice on August 29th, 2014 [ permalink ] | Read more »
Baseball Battle Review
Baseball Battle Review By Jennifer Allen on August 29th, 2014 Our Rating: :: SIMPLE HITTINGUniversal App - Designed for iPhone and iPad Simple and cute, Baseball Battle is a fairly fun baseball game for those looking for something... | Read more »
Checkmark 2.1 Update Released, and it’s...
Checkmark 2.1 Update Released, and it’s on Sale for a Limited Time Posted by Jessica Fisher on August 29th, 2014 [ permalink ] | Read more »

Price Scanner via MacPrices.net

Labor Day Weekend MacBook Pro sale; 15-inch m...
B&H Photo has the new 2014 15″ Retina MacBook Pros on sale for up to $125 off MSRP. Shipping is free, and B&H charges NY sales tax only. They’ll also include free copies of Parallels Desktop... Read more
Labor Day Weekend iPad mini sale; $50 to $100...
Best Buy has the iPad mini with Retina Display (WiFi models) on sale for $50 off MSRP on their online store for Labor Day Weekend. Choose free shipping or free local store pick up. Price is for... Read more
13-inch 1.4GHz MacBook Air on sale for $899,...
Adorama has the new 2014 13″ 1.4GHz/128GB MacBook Air on sale for $899.99 including free shipping plus NY & NJ tax only. Their price is $100 off MSRP. Read more
It’s Official: Apple Issues Invitations To Se...
Apple has issued one of its characteristically cryptic press invitations for a special event to be held at the Flint Center for the Performing Arts in hometown Cupertino on Sept. 9, 2014 at 10:00 am... Read more
Tablet Shipments To See First On-year Decline...
TrendForce analyst Caroline Chen notes that when the iPad launched in 2010, it was an instant hit and spurred a tablet PC revolution, with tablets so popular that that notebook PC sales stagnated and... Read more
SOBERLINK Releases Apple iOS Compatible Handh...
Cypress, California based SOBERLINK, Inc., creator of the first handheld Breathalyzer designed to improve recovery outcomes, continues to show prominence in the mobile alcohol monitoring space with... Read more
New 21″ 1.4GHz iMac on sale again for $999, s...
Best Buy has the new 21″ 1.4GHz iMac on sale for $999.99 on their online store. Their price is $100 off MSRP. Choose free shipping or free local store pick up. Price is for online orders only, in-... Read more
Smartphone Outlook Remains Strong for 2014, U...
According to a new mobile phone forecast from the International Data Corporation (IDC) Worldwide Quarterly Mobile Phone Tracker, more than 1.25 billion smartphones will be shipped worldwide in 2014,... Read more
Save up to $60 with Apple refurbished iPod to...
The Apple Store has Apple Certified Refurbished 5th generation iPod touches available starting at $149. Apple’s one-year warranty is included with each model, and shipping is free. Many, but not all... Read more
12-Inch MacBook Air Coming in 4Q14 or 2015 –...
Digitimes’ Aaron Lee and Joseph Tsai report that according to Taiwan-based upstream supply chain insiders, Apple plans to launch a thinner MacBook model either at year end 2014 or in 2015, and that... 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* 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* 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* 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
Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.