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.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Ember 1.8.3 - Versatile digital scrapboo...
Ember (formerly LittleSnapper) is your digital scrapbook of things that inspire you: websites, photos, apps or other things. Just drag in images that you want to keep, organize them into relevant... Read more
Apple iTunes 12.1 - Manage your music, m...
Apple iTunes lets you organize and play digital music and video on your computer. It can automatically download new music, app, and book purchases across all your devices and computers. And it's a... Read more
LibreOffice 4.4.3 - Free, open-source of...
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
FoldersSynchronizer 4.2.1 - Synchronize...
FoldersSynchronizer is a popular and useful utility that synchronizes and backs-up files, folders, disks and boot disks. On each session you can apply special options like Timers, Multiple Folders,... Read more
Simon 4.0.2 - 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
Cocktail 8.1.2 - General maintenance and...
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
Cyberduck 4.6.4 - FTP and SFTP browser....
Cyberduck is a robust FTP/FTP-TLS/SFTP browser for the Mac whose lack of visual clutter and cleverly intuitive features make it easy to use. Support for external editors and system technologies such... Read more
Herald 5.0.2 - Notification plugin for M...
Note: Versions 2.1.3 (for OS X 10.7), 3.0.6 (for OS X 10.8), and 4.0.8 (for OS X 10.9) are no longer supported by the developer. Herald is a notification plugin for Mail.app, Apple's Mac OS X email... Read more
DEVONthink Pro 2.8.3 - Knowledge base, i...
Save 10% with our exclusive coupon code: MACUPDATE10 DEVONthink Pro is your essential assistant for today's world, where almost everything is digital. From shopping receipts to important research... Read more
Boom 2 1.0.1 - System-wide pro audio app...
Boom 2 is a system-wide volume booster and equalizer app that is designed especially for OS X 10.10 Yosemite. It comes with a smart interface, self-calibrates itself according to your Mac, offers... Read more

Playworld Superheroes Review
Playworld Superheroes Review By Tre Lawrence on January 30th, 2015 Our Rating: :: HERO CRAFTINGUniversal App - Designed for iPhone and iPad It’s all about the imagination, fighting bad creatures — and looking good while doing so.   | Read more »
Join the SpongeBob Bubble Party in this...
Join the SpongeBob Bubble Party in this New Match 3 Bubble Poppin’ Frenzy Posted by Jessica Fisher on January 30th, 2015 [ permalink ] | Read more »
Handpick Review
Handpick Review By Jennifer Allen on January 30th, 2015 Our Rating: :: TANTALIZING SUGGESTIONSiPhone App - Designed for the iPhone, compatible with the iPad Handpick will make you hungry, as well as inspire you to cook something... | Read more »
Storm the Halls of Echo Base in First St...
Storm the Halls of Echo Base in First Star Wars: Galactic Defense Event Posted by Jessica Fisher on January 30th, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Contradiction Review
Contradiction Review By Tre Lawrence on January 30th, 2015 Our Rating: :: SPOT THE LIEiPad Only App - Designed for the iPad Contradiction is a live action point and click adventure that’s pretty engaging.   Developer: Tim Follin... | Read more »
Unlock Sunshine Girl in Ironkill with th...
Unlock Sunshine Girl in Ironkill with this special 148Apps code Posted by Rob Rich on January 29th, 2015 [ permalink ] Robo-fighter Ironkill has been out on iOS a | Read more »
Crossroad Zombies Review
Crossroad Zombies Review By Jordan Minor on January 29th, 2015 Our Rating: :: CROSSWALKING DEADiPad Only App - Designed for the iPad Crossroad Zombies is a rough draft of a cool genre mash-up.   | Read more »
Blood Brothers 2 – Tips, Cheats, and Str...
War is hell: Is it the kind of hell you want to check out? Read our Blood Brothers 2 review to find out! Blood Brothers 2, DeNA’s follow-up to the original Blood Brothers, is an intriguing card collecting / role-playing / strategy hybrid. There’s... | Read more »
Blood Brothers 2 Review
Blood Brothers 2 Review By Nadia Oxford on January 29th, 2015 Our Rating: :: AN AGGRAVATING RELATIVEUniversal App - Designed for iPhone and iPad Blood Brothers 2 is built on a simple, solid foundation, but its free-to-play system... | Read more »
I AM BREAD, the Toast of the Town, is Ro...
Have you ever dreamt of being deliciously gluten-y? Do you feel passionate about Rye and Wheat? The guys at Bossa Studios do and that is why they are bringing I AM BREAD to iOS soon. The loafy app will feature all the new content that is being... | Read more »

Price Scanner via MacPrices.net

Intel Aims to Transform Workplace With 5th-Ge...
Intel Corporation today announced the availability of its 5th generation Intel Core vPro processor family that provides cutting-edge features to enable a new and rapidly shifting workplace. To meet... Read more
iOS App Sharalike Introduces New Instant Smar...
Sharalike slideshow and photo management software for iOS, is making it easier than ever to create shareable meaningful moments with its new instant SmartShow technology. Staying organized is a goal... Read more
Apple Becomes World’s Largest Smartphone Vend...
According to the latest research data from Strategy Analytics, as global smartphone shipments grew 31 percent annually to reach a record 380 million units in the fourth quarter of 2014. Apple became... Read more
Cut the Cord: OtterBox Resurgence Power Case...
Dead batteries and broken phones are two of the biggest issues for smartphone users today. Otterbox addresses both with the new Resurgence Power Case for Apple iPhone 6, promising to make those panic... Read more
13-inch Retina MacBook Pros on sale for up to...
B&H Photo has 13″ Retina MacBook Pros on sale for $200 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.6GHz/128GB Retina MacBook Pro: $1199.99 save $100 - 13″ 2.6GHz/... Read more
15-inch 2.5GHz Retina MacBook Pro on sale for...
 B&H Photo has the 15″ 2.5GHz Retina MacBook Pro on sale for $2319.99 including free shipping plus NY sales tax only. Their price is $180 off MSRP, and it’s the lowest price available for this... Read more
Back in stock: Refurbished iPod nanos for $99...
The Apple Store has Apple Certified Refurbished 16GB iPod nanos available for $99 including free shipping and Apple’s standard one-year warranty. That’s $50 off the cost of new nanos. Most colors are... Read more
Apple lowers price on refurbished 256GB MacBo...
The Apple Store has lowered prices on Apple Certified Refurbished 2014 MacBook Airs with 256GB SSDs, now available for up to $200 off the cost of new models. An Apple one-year warranty is included... Read more
New Good Management Suite Simplifies Enterpri...
Good Technology has announced the availability of the Good Management Suite, a comprehensive cross-platform solution for organizations getting started with mobile business initiatives. Built on the... Read more
15-inch 2.0GHz Retina MacBook Pro (refurbishe...
The Apple Store has Apple Certified Refurbished previous-generation 15″ 2.0GHz Retina MacBook Pros available for $1489 including free shipping plus Apple’s standard one-year warranty. Their price is... Read more

Jobs Board

*Apple* Solutions Consultant- Retail Sales (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
Event Director, *Apple* Retail Marketing -...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global engagement strategy and team. Delivering an overarching brand Read more
At-Home Chat Specialist- *Apple* Online Stor...
**Job Summary** At Apple , we believe in hard work, a fun environment, and the kind of creativity and innovation that only comes about when talented people from diverse Read more
SW QA Engineer - *Apple* TV - Apple (United...
**Job Summary** The Apple TV team is looking for experienced Quality Assurance Engineers with a passion for delivering first in class home entertainment solutions. **Key Read more
*Apple* Retail - Multiple Positions(US) - Ap...
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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.