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

Apple iTunes 12.2 - Play Apple Music...
Apple iTunes lets you organize and stream Apple Music, download and watch video and listen to Podcasts. It can automatically download new music, app, and book purchases across all your devices and... Read more
Apple Security Update 2015-005 - For OS...
Apple Security Update 2015-005 is recommended for all users and improves the security of OS X. For detailed information about the security content of this update, please visit: http://support.apple.... Read more
Apple HP Printer Drivers 3.1 - For OS X...
Apple HP Printer Drivers includes the latest HP printing and scanning software for OS X Lion or later. For information about supported printer models, see this page. Version 3.1: The latest printing... Read more
Epson Printer Drivers 3.1 - For OS X 10....
Epson Printer Drivers installs the latest software for your EPSON printer or scanner for OS X Yosemite, OS X Mavericks, OS X Mountain Lion, and OS X Lion. For more information about printing and... Read more
Xcode 6.4 - Integrated development envir...
Xcode provides everything developers need to create great applications for Mac, iPhone, and iPad. Xcode brings user interface design, coding, testing, and debugging into a united workflow. The Xcode... Read more
OS X Yosemite 10.10.4 - Apple's lat...
OS X Yosemite is Apple's newest operating system for Mac. An elegant design that feels entirely fresh, yet inherently familiar. The apps you use every day, enhanced with new features. And a... Read more
Dash 3.0.2 - Instant search and offline...
Dash is an API Documentation Browser and Code Snippet Manager. Dash helps you store snippets of code, as well as instantly search and browse documentation for almost any API you might use (for a full... Read more
FontExplorer X Pro 5.0 - Font management...
FontExplorer X Pro is optimized for professional use; it's the solution that gives you the power you need to manage all your fonts. Now you can more easily manage, activate and organize your... Read more
Typinator 6.6 - Speedy and reliable text...
Typinator turbo-charges your typing productivity. Type a little. Typinator does the rest. We've all faced projects that require repetitive typing tasks. With Typinator, you can store commonly used... Read more
Arq 4.12.1 - Online backup to Google Dri...
Arq is super-easy online backup for the Mac. Back up to your own Google Drive storage (15GB free storage), your own Amazon Glacier ($.01/GB per month storage) or S3, or any SFTP server. Arq backs up... Read more

Vector 2 is Officially a Thing and it...
Vector is a pretty cool parkour-driven runner that's gotten a pretty decent following since it first came out - although personally I think more people could stand to show it some love. Anyway, Nekki has announced that a sequel isofficially on its... | Read more »
This Week at 148Apps:June 22-26, 2015
June's Summer Journey Continues With 148Apps How do you know what apps are worth your time and money? Just look to the review team at 148Apps. We sort through the chaos and find the apps you're looking for. The ones we love become Editor’s Choice,... | Read more »
LEGO® Minifigures Online (Games)
LEGO® Minifigures Online 1.0.1 Device: iOS iPhone Category: Games Price: $4.99, Version: 1.0.1 (iTunes) Description: | Read more »
World of Tanks Blitz celebrates its firs...
Today marks the first anniversary of the launch of World of Tanks Blitz, the mobile version of the PC tank battler, World of Tanks. World of Tanks Blitz launched on iOS and Android on June 26th last year and to celebrate, Wargaming is giving all... | Read more »
Heroes and Castles 2 Has its Own Standal...
Heroes and Castles 2 is a third-person castle defense game from the same team behind Block Fortress and Bug Heroes. It's cool, it's fun, and now it has its very own free version. [Read more] | Read more »
Formula Cartoon All-Stars Lets You Race...
Ever want to pit your favorite characters from shows like Steven Universe, Adventure Time, and Regular Show against each other in a not quite death race? Well once upon a time you could, but Formula All Stars Touch N' Go doesn't exist anymore. Hope... | Read more »
Retype - Typography Photo Editor (Photo...
Retype - Typography Photo Editor 1.0 Device: iOS Universal Category: Photography Price: $2.99, Version: 1.0 (iTunes) Description: Retype is built out of passion for great typography and it's all about adding text to photo with style... | Read more »
Hungry Shark Evolution Celebrates Shark...
Shark Week is almost here, as is Independence Day, so naturally Hungry Shark Evolution is going to get in on the action. Yes, even the fireworks. [Read more] | Read more »
The New Trivia Crack Will Feature a Musi...
It's official: iHeartMedia (you may know them from iHeartRadio) will be in charge of providing music-related questions for Trivia Crack's upcoming sequel. Also Trivia Crack is getting a sequel. [Read more] | Read more »
Toca Life: City (Education)
Toca Life: City 1.0 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0 (iTunes) Description: Welcome to Toca Life: City, a metropolis filled with everyday fun! Customize characters, explore exciting locations and... | Read more »

Price Scanner via MacPrices.net

12-inch 1.2GHz Gray MacBook on sale for $1487...
Amazon.com has the new 12″ 1.2GHz Gray MacBook in stock and on sale for $1487 including free shipping. Their price is $102 off MSRP, and it’s the lowest price available for this model. We expect... Read more
15-inch 2.2GHz Retina MacBook Pro on sale for...
Amazon.com has the 15″ 2.2GHz Retina MacBook Pro on sale for $1819 including free shipping. Their price is $180 off MSRP, and it’s the lowest price available for this model. Read more
OtterBox Releases New Symmetry Series Metalli...
Otterbox’s new Symmetry Series of smartphone cases flaunts the best of both both street style and street smarts with their new metallic finishes and trusted OtterBox protection for iPhone 6 and... Read more
Eliminate Cable Chaos with New GE Branded Wra...
GE licensee Jasco Products has introduced a new line of GE branded Wrap-n-Charge USB wall chargers with built-in cable management. “We are always working to combine great technology with innovative... Read more
2015 13-inch 2.7GHz Retina MacBook Pro on sal...
B&H Photo has the new 2015 13″ 2.7GHz/128GB Retina MacBook Pro on sale today for $1199 including free shipping plus NY sales tax only. Their price is $100 off MSRP, and it’s the lowest price for... Read more
13-inch 2.5GHz MacBook Pro (refurbished) avai...
The Apple Store has Apple Certified Refurbished 13″ 2.5GHz MacBook Pros available for $829, or $270 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.... Read more
Apple refurbished iPad Air 2s available for u...
The Apple Store has Apple Certified Refurbished iPad Air 2s available for up to $140 off the price of new models. Apple’s one-year warranty is included with each model, and shipping is free: - 128GB... Read more
MacBook Airs on sale for up to $75 off MSRP
Save up to $75 on the purchase of a new 2015 13″ or 11″ 1.6GHz MacBook Air at the following resellers. Shipping is free with each model: 11" 128GB MSRP $899 11" 256GB... Read more
Apple’s Education discount saves up to $300 o...
Purchase a new Mac or iPad at The Apple Store for Education and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free,... Read more
Save up to $600 with Apple refurbished Mac Pr...
The Apple Store has Apple 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... Read more

Jobs Board

*Apple* TV Live Streaming Frameworks Test En...
**Job Summary** Work and contribute towards the engineering of Apple 's state-of-the-art products involving video, audio, and graphics in Interactive Media Group (IMG) at Read more
Project Manager, WW *Apple* Fulfillment Ope...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
Senior Data Scientist, *Apple* Retail - Onl...
**Job Summary** Apple Retail - Online sells Apple products to customers around the world. In addition to selling Apple products with unique services such as iPad Read more
*Apple* Music Producer - Apple (United State...
**Job Summary** Apple Music seeks a Producer to help shepherd some of the most important content and editorial initiatives within the music app, with a particular focus Read more
Sr. Technical Services Consultant, *Apple*...
**Job Summary** Apple Professional Services (APS) has an opening for a senior technical position that contributes to Apple 's efforts for strategic and transactional Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.