TweetFollow Us on Twitter

The Philosophy of Cocoa: Small is Beautiful and Lazy is Good

Volume Number: 18 (2002)
Issue Number: 8
Column Tag: Mac OS X

The Philosophy of Cocoa: Small is Beautiful and Lazy is Good

by Andrew C. Stone

I believe a programming renaissance is upon us--and Cocoa, Apple's high level object-oriented framework is at the heart of it. By wrapping complexity inside easy-to-use objects, Cocoa frees application developers from the burden of the minutiae that so often drives developers crazy. Instead, they can focus on what's special about their applications, and in a few lines of code, create a complete OS X application that seamlessly interoperates with all other OS X applications. And, for very little additional effort, they get AppleScriptability as well.

I've been living and breathing Cocoa and its various previous incarnations for 14 years now, and have noticed that my applications are getting more features with smaller amounts of code each year. This article will explore some of the truisms and gems hard earned by hanging in the trenches lo these many years.

Small is Beautiful

It's no coincidence that we use the term "architecture" for the overarching structure of an application. I received my baccalaureate in classical Architecture in the '70's when the visionaries of the time were rebelling against the huge concrete boxes that crushed the human scale and spirit. E. F. Schumacher, in Small is Beautiful -- A Study of Economics as if People Mattered:

    "What I wish to emphasise is the duality of the human requirement when it comes to the question of size: there is no single answer. For his different purposes man needs many different structures, both small ones and large ones, some exclusive and some comprehensive. Yet people find it most difficult to keep two seemingly opposite necessities of truth in their minds at the same time. They always tend to clamour for a final solution, as if in actual life there could ever be a final solution other than death. For constructive work, the principal task is always the restoration of some kind of balance. Today, we suffer from an almost universal idolatry of giantism. It is therefore necessary to insist on the virtues of smallness - where this applies. ..." (p. 54)

I believe this thinking still rings true 30 years later in cyber-architecture.

From the programming classic The Mythical Man Month by Frederick P. Brooks, Jr., we learned that the more programmers you throw at a project, the less likely the project will ever be finished! From this follows that a project should have one central architect, with rather fascist control over feature set and implementation, especially if you want it to ship in a timely fashion. Cocoa gives you the tools needed to build full-featured, world-class applications with just a handful of programmers. For best effect, these programmers should be lazy...

Lazy is Good

Laziness is a virtue, believe it or not! I often describe my style of a computer scientist as someone who is so lazy that they'll spend days writing software to save a minute each time the task is performed from then on. There are two forms of laziness that Cocoa embraces: lazy loading of objects and just plain lazy programming.

Bundle it Up

Lazy loading lets full-featured applications like Stone Design's Create(R), a three-in-one illustration, page layout and web authoring app, launch in just a few seconds. Compare that to a legacy Carbon application with half the features which takes minutes to launch! By using dynamically loaded bundles, you do not use memory or resources until the end user actually needs that particular feature and its related resources. Moreover, you can update and distribute just the tiny bundle instead of the whole application should, heaven forbid, a bug be found!

To use dynamically loaded bundles, you need to be able to compile your application without actually referencing the loadable object directly. We do this runtime magic by only referring to the dynamically loaded class, the principal class of the bundle, by its name as a string.

Typically, the types of objects that do well being loaded dynamically are the numerous special editors and interfaces in a program, such as an arrow or pattern editor and the classes it needs to provide the interface. The following conditions make up a good candidate for a loadable bundle:

  • Has resources that are not always used each session

  • Doesn't contain core data model classes (these should be linked)

A typical example might have an NSWindowController subclass and perhaps some custom views and images in the bundle. We load this type of bundle by having it respond to the class method "+sharedInstance", since you usually only need one of these objects per application:

- (void)loadAUniqueInterfaceObjectAction:(id)sender {
    // we only use the name of the bundle, not its class
    // which would cause an undefined symbol when linking:
    [[[NSApp delegate] sharedInstanceOfClassName:@"MyUniqueController"] showWindow:self];
}

But, with the introduction of sheets, two or more documents may want to load the same bundle (for example, a custom zoom sheet) at the same time. In this case, you'll want a unique instance, which will be released after use. These principal classes of bundles need only respond to -(id)init, which all objects do anyway since they inherit from NSObject which implements -(id)init;

- (void)loadAPerDocumentInterfaceObjectAction:(id)sender {
   [[[NSApp delegate] instanceOfClassName:@"MyPerDocumentController"] showWindow:self];
}

And, because we are lazy and more importantly, good programmers, we filter both of these methods through one factored method, -(id)instanceOfClassName:(NSString *)name shared:(BOOL)shared like this:

- (id)sharedInstanceOfClassName:(NSString *)name
{
    return [self instanceOfClassName:name shared:YES];
}
- (id)instanceOfClassName:(NSString *)name {
   return [self instanceOfClassName:name shared:NO];
}

And here's the non-linked bundle loading code for both of them, which we place for convenience in the globally available [NSApp delegate] class:

- (id)instanceOfClassName:(NSString *)name shared:(BOOL)shared
{
    id obj = nil;
    NSString *path = [[NSBundle mainBundle] pathForResource:name ofType:@"bundle"];
    if (path) {
        // we found the bundle, now load it:
        NSBundle *b = [[NSBundle allocWithZone:NULL] initWithPath:path];
       // if it loads, see if it has a valid principalClass - this is set in PB's target inspector
        if ((b != nil) && ([b principalClass] !=NULL)) {
     // here is the only difference between a single shared instance
     // and a new one every time:
            if (shared) obj = [[b principalClass] sharedInstance];
            else obj = [[[b principalClass] allocWithZone:NULL] init];
        } else {
   // This is for debugging in case it can't be loaded:
   NSLog(@"Can't Load %@!\n", path);
        }
    } else NSLog(@"Couldn't find %@ bundle!\n",name);
    return obj;
}

Code Lazily

Lazy programming means "Use the 'Kit, Luke!" Every standard data structure and a complete set of API's are already available to you, so there is rarely a need to reinvent your own. Therefore, this lazy programming axiom has a corollary:

If it's hard to do or understand, it's wrong

By this I mean any coding solution that involves convoluted logic or going beneath the API (using undocumented methods) is probably not the right approach. Taking the time to understand what's already offered to you is well worth the effort, because Cocoa, and its underlying frameworks, Foundation and AppKit, have evolved over 16 years to provide the basic building blocks of an object oriented solution. Many times when I'm adding a new feature, I'll try one brute force approach, notice how cumbersome it is, re-read the AppKit or Foundation API and find a much a better solution involving much less code.

For example, I recently added a "Clone Client" feature to TimeEqualsMoney(TM) - take the current document's data, remove the individual time entries, create a new document with all the same settings except no time entries. It was six lines of code and it worked the first time:

- (void)cloneDocumentAction:(id)sender {
    // make a new untitled - have it read our document:
    NSMutableDictionary *doc = [self workDocumentDictionary];
    MyDocument *newDoc = [[NSDocumentController sharedDocumentController]
openUntitledDocumentOfType:DocumentType display:NO];
    [doc removeObjectForKey:WorkKey];
    [newDoc loadDataRepresentation:[[doc description] dataUsingEncoding:NSASCIIStringEncoding] 
    ofType:DocumentType];
    [newDoc makeWindowControllers];
    [[[newDoc windowControllers] objectAtIndex:0] showWindow:self];
}

Instead of hiring programmers, why not let the entire Cocoa team at Apple be your engineers? When you use the Kit and Apple puts in new functionality and bug fixes, your application automatically gains these features and fixes. Your efforts should be focused on creating a mapping between the real world problems you are solving and the objects that represent them. Which brings me to my next point:

Put The Code Where It Belongs

One of the biggest challenges facing newcomers to Object Oriented Programming is placing code in the right object. Because many of us grew up with "procedural" languages like Basic, Pascal, and C, and because old habits die hard, we need to let go of trying to tell things what do to do, and instead, let them figure it out for themselves. Let's say we have a document which is a list of pages, which contains a list of graphics, which are simple graphics or groups, which contain a list of graphics, which are graphics or groups which contain, etc... And let's say we want to set the "isVisible" state of all the graphics in the document.

The procedural approach would be to assume absolute knowledge over this hierarchy, and you'd blithely code something like this:

@implementation MyDocument
// please don't do this!
- (void)setAllObjectsVisible:(BOOL)isVisible {
    unsigned int i, pageCount = [_pages count];
    for (i = 0; i < pageCount; i++) {
        Page *p = [_pages objectAtIndex:i];
        NSArray *graphics = [p graphics];
        unsigned int j, graphicsCount = [graphics count];
        for (j = 0; j < graphicsCount; j++) {
            Graphic *g = [graphics objectAtIndex:j];
            if ([g isKindOfClass:[Group class]) {
                NSArray *groupGraphics = [g graphics];
                unsigned k,groupGraphicsCount = [groupGraphics count];
                for (k = 0; k < groupGraphicsCount; k++) {
   // since this only recurses one level, this code is wrong as
   // well as very hard to read and maintain!!!
   Graphic *groupedGraphic = [groupGraphics objectAtIndex:k];
   [k setVisible:isVisible];
                }
            else [g setVisible:isVisible];
        }
    }
)
// the OO way:
@implementation MyDocument
- (void)setAllObjectsVisible:(BOOL)isVisible {
     [_pages makeObjectsPerformSelector:@selector(setAllObjectsVisible:) withObject:(id)isVisible];
}
...
@implementation Page
- (void)setAllObjectsVisible:(BOOL)isVisible {
     [_graphics makeObjectsPerformSelector:@selector(setVisible:) withObject:(id)isVisible];
}
....
// groups need to recurse down the hierarchy until individual graphics
// are found...
@implementation Group
- (void)setVisible:(BOOL)isVisible {
    [_graphics makeObjectsPerformSelector:@selector(setVisible:) withObject:(id)isVisible];
}
@implementation Graphic
- (void)setVisible:(BOOL)isVisible {
   // only do work if you absolutely have to - remember LAZY!
    if (_isVisible != isVisible) {
   // you'd probably do undo manager stuff here
   _isVisible = isVisible;
   // alert page we need to be redrawn
   [self tellMyPageToInvalidateMyBounds];
    }
}
...

Conclusion

The more you understand object oriented programming and Cocoa, the smaller and more reusable your applications will become. And they will load with lightning speed! But more importantly, you'll have less code to maintain which means less bugs, less headaches and more time to enjoy life.


Andrew Stone, CEO of Stone Design, www.stone.com, has been the principal architect of several solar houses and over a dozen Cocoa applications shipping for Mac OS X.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Vivaldi 1.10.867.48 - An advanced browse...
Vivaldi is a browser for our friends. In 1994, two programmers started working on a web browser. Our idea was to make a really fast browser, capable of running on limited hardware, keeping in mind... Read more
EarthDesk 7.2 - Striking real-time anima...
EarthDesk replaces your static desktop picture with a rendered image of Earth showing correct sun, moon, and city illumination. With an Internet connection, EarthDesk displays near-real-time global... Read more
Fission 2.3.2 - Streamlined audio editor...
Fission can crop and trim audio, paste in or join files, or just rapidly split one long file into many. It's streamlined for fast editing. Plus, it works without the quality loss caused by other... Read more
Drive Genius 5.0.3 - Powerful system uti...
Drive Genius gives you faster performance from your Mac while also protecting it. The award-winning and improved DrivePulse feature alerts you to hard drive issues before they become major problems.... Read more
iDefrag 5.2.0 - Disk defragmentation and...
iDefrag helps defragment and optimize your disk for improved performance. iDefrag Features Supports HFS and HFS+ (Mac OS Extended). Supports case sensitive and journaled filesystems. Supports... Read more
Things 3.1.1 - Elegant personal task man...
Things is a task management solution that helps to organize your tasks in an elegant and intuitive way. Things combines powerful features with simplicity through the use of tags and its intelligent... Read more
GraphicConverter 10.4.3 - $39.95
GraphicConverter is an all-purpose image-editing program that can import 200 different graphic-based formats, edit the image, and export it to any of 80 available file formats. The high-end editing... Read more
Google Chrome 60.0.3112.78 - Modern and...
Google Chrome is a Web browser by Google, created to be a modern platform for Web pages and applications. It utilizes very fast loading of Web pages and has a V8 engine, which is a custom built... Read more
PDFpenPro 9.1 - Advanced PDF toolkit for...
PDFpenPro allows users to edit PDF's easily. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Create fillable forms and tables of content... Read more
PDFpen 9.1 - $74.95
PDFpen allows users to easily edit PDF's. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Even correct text and edit graphics! Features... Read more

Latest Forum Discussions

See All

Mix and match magical brews in Miracle M...
Miracle Merchant, the charming fantasy card game by Tiny Touch Tales, is arriving next week. The development team, which also brought you Card Crawl and Card Thief, announced the game's launch with a pleasant little trailer that showcases the game'... | Read more »
Last Day on Earth: Zombie Survival guide...
Last Day on Earth: Zombie Survival is the latest big hit in the survival game craze. The gist of the game is pretty cut and dry -- try your best to survive in a world overrun by flesh-eating zombies. But Last Day on Earth justifies the hype... | Read more »
Eden: Renaissance (Games)
Eden: Renaissance 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Eden: Renaissance is a thrilling turn-based puzzle adventure set in a luxurious world, offering a deep and moving... | Read more »
Glyph Quest Chronicles guide - how to ma...
Glyph Quest returns with a new free-to-play game, Glyph Quest Chronicles. Chronicles offers up more of the light-hearted, good humored fantasy fun that previous games featured, but with a few more refined tricks up its sleeve. It's a clever mix of... | Read more »
Catch yourself a Lugia and Articuno in P...
Pokémon Go Fest may have been a bit of a disaster, with Niantic offering fans full refunds and $100 worth of in-game curency to apologize for the failed event, but that hasn't ruined trainers' chances of catching new legendary Pokémon. Lugia nad... | Read more »
The best deals on the App Store this wee...
There are quite a few truly superb games on sale on the App Store this week. If you haven't played some of these, many of which are true classics, now's the time to jump on the bandwagon. Here are the deals you need to know about. [Read more] | Read more »
Realpolitiks Mobile (Games)
Realpolitiks Mobile 1.0 Device: iOS Universal Category: Games Price: $5.99, Version: 1.0 (iTunes) Description: PLEASE NOTE: The game might not work properly on discontinued 1GB of RAM devices (iPhone 5s, iPhone 6, iPhone 6 Plus, iPad... | Read more »
Layton’s Mystery Journey (Games)
Layton’s Mystery Journey 1.0.0 Device: iOS Universal Category: Games Price: $15.99, Version: 1.0.0 (iTunes) Description: THE MUCH-LOVED LAYTON SERIES IS BACK WITH A 10TH ANNIVERSARY INSTALLMENT! Developed by LEVEL-5, LAYTON’S... | Read more »
Full Throttle Remastered (Games)
Full Throttle Remastered 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Originally released by LucasArts in 1995, Full Throttle is a classic graphic adventure game from industry legend Tim... | Read more »
Stunning shooter Morphite gets a new tra...
Morphite is officially landing on iOS in September. The game looks like the space shooter we've been needing on mobile, and we're going to see if it fits the bill quite shortly. The game's a collaborative effort between Blowfish Studios, We're Five... | Read more »

Price Scanner via MacPrices.net

Photographer Explains Choosing Dell Laptop Ov...
Last week photographer and video blogger Manny Ortiz posted a video explaining the five most important reasons he settled on a Dell XPS 15 laptop instead of a MacBook Pro for his latest portable... Read more
Sale! 10-inch iPad Pros for $50 off MSRP, no...
B&H Photo has 64GB and 256GB 10.5″ iPad Pros in stock today and on sale for $50 off MSRP. Each iPad includes free shipping, and B&H charges sales tax in NY & NJ only: – 10.5″ 64GB iPad... Read more
WaterField Designs Upgrades TSA-friendly Zip...
San Francisco based designer and manufacturer Waterfield Designs has unveiled an upgraded and refined Zip Brief. Ideal for the minimalist professional, the ultra-slim Zip laptop bag actually holds a... Read more
USB 3.0 Promoter Group Announces USB 3.2 Upda...
The USB 3.0 Promoter Group has announced the pending release of the USB 3.2 specification, an incremental update that defines multi-lane operation for new USB 3.2 hosts and devices. USB Developer... Read more
Save on MacBook Pros with Apple Refurbished 2...
Apple recently dropped prices on Certified Refurbished 2016 15″ and 13″ MacBook Pros with models now as much as $590 off original MSRP. An Apple one-year warranty is included with each model, and... Read more
13-inch 2.3GHz/256GB MacBook Pros on sale for...
B&H Photo has 13″ 2.3GHz/256GB MacBook Pros in stock today and on sale for $100 off MSRP including free shipping plus NY & NJ sales tax only: – 13-inch 2.3GHz/256GB Space Gray MacBook Pro (... Read more
Clearance 2016 13-inch MacBook Airs, Apple re...
Apple has Certified Refurbished 2016 13″ MacBook Airs available starting at $809. An Apple one-year warranty is included with each MacBook, and shipping is free: – 13″ 1.6GHz/8GB/128GB MacBook Air: $... Read more
PHOOZY World’s First Thermal Capsules to Summ...
Summer days spent soaking up the sun can be tough on smartphones, causing higher battery consumption and overheating. To solve this problem, eXclaim IP, LLC has introduced the PHOOZY Thermal Capsule... Read more
2018 Honda Ridgeline with Android Auto and Ap...
The 2018 Honda Ridgeline is arriving in dealerships nationwide with a Manufacturer’s Suggested Retail Price (MSRP1) starting at $29,630. The 2017 Honda Ridgeline was named North American Truck of the... Read more
comScore Ranks Top 15 U.S. Smartphone Apps fo...
comScore, Inc. recently released data from comScore Mobile Metrix, reporting the top smartphone apps in the U.S. by audience reach for June 2017. * “Apple Music,” as it appears in comScore’s monthly... Read more

Jobs Board

*Apple* Solutions Consultant (ASC) - Poole -...
Job Summary The people here at Apple don't just create products - they create the kind of wonder that's revolutionised entire industries. It's the diversity of those Read more
SW Engineer *Apple* TV - Apple Inc. (United...
Changing the world is all in a day's work at Apple . If you love innovation, here's your chance to make a career of it. You'll work hard. But the job comes with more Read more
Frameworks Engineering Manager, *Apple* Wat...
Frameworks Engineering Manager, Apple Watch Job Number: 41632321 Santa Clara Valley, California, United States Posted: Jun. 15, 2017 Weekly Hours: 40.00 Job Summary Read more
Product Manager - *Apple* Pay on the *Appl...
Job Summary Apple is looking for a talented product manager to drive the expansion of Apple Pay on the Apple Online Store. This position includes a unique Read more
*Apple* Retail - Multiple Positions - Apple...
SalesSpecialist - Retail Customer Service and SalesTransform 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.