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

Viber 11.9.1 - Send messages and make fr...
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, so... Read more
Vallum 3.3.2 - $15.00
Vallum is a little tool that helps you monitor and block apps connections and throttle apps bandwidth. It is able to intercept connections at the application layer, and hold them while you decide... Read more
Microsoft OneNote 16.31 - Free digital n...
OneNote is your very own digital notebook. With OneNote, you can capture that flash of genius, that moment of inspiration, or that list of errands that's too important to forget. Whether you're at... Read more
Apple Pages 8.2.1 - Apple's word pr...
Apple Pages is a powerful word processor that gives you everything you need to create documents that look beautiful. And read beautifully. It lets you work seamlessly between Mac and iOS devices, and... Read more
Numbers 6.2.1 - Apple's spreadsheet...
With Apple Numbers, sophisticated spreadsheets are just the start. The whole sheet is your canvas. Just add dramatic interactive charts, tables, and images that paint a revealing picture of your data... Read more
f.lux 39.9873 - Adjusts the color of you...
f.lux makes the color of your computer's display adapt to the time of day, warm at night and like sunlight during the day. Ever notice how people texting at night have that eerie blue glow? Or wake... Read more
Deeper 2.5.0 - Enable hidden features in...
Deeper is a personalization utility for macOS which allows you to enable and disable the hidden functions of the Finder, Dock, QuickTime, Safari, iTunes, login window, Spotlight, and many of Apple's... Read more
NTFS 15.5.71 - Provides full read and wr...
NTFS breaks down the barriers between Windows and macOS. Paragon NTFS effectively solves the communication problems between the Mac system and NTFS. Write, edit, copy, move, delete files on NTFS... Read more
MTR 5.3.0.0 - The Mac's oldest and...
MTR (was MacTheRipper)--the Mac's oldest and smartest DVD-backup app. MTR - the complete toolbox, not a one-trick, point-and-click extractor. MTR is intended for making fair-use, backup copies of... Read more
Keynote 9.2.1 - Apple's presentatio...
Easily create gorgeous presentations with the all-new Keynote, featuring powerful yet easy-to-use tools and dazzling effects that will make you a very hard act to follow. The Theme Chooser lets you... Read more

Latest Forum Discussions

See All

Black Desert Mobile gets an official rel...
Pearl Abyss has just announced that its highly-anticipated MMO, Black Desert Mobile, will launch globally for iOS and Android on December 11th. [Read more] | Read more »
Another Eden receives new a episode, cha...
Another Eden, WFS' popular RPG, has received another update that brings new story content to the game alongside a few new heroes to discover. [Read more] | Read more »
Overdox guide - Tips and tricks for begi...
Overdox is a clever battle royale that changes things up by adding MOBA mechanics and melee combat to the mix. This new hybrid game can be quite a bit to take in at first, so we’ve put together a list of tips to help you get a leg up on the... | Read more »
Roterra Extreme - Great Escape is a pers...
Roterra Extreme – Great Escape has been described by developers Dig-It Games as a mini-sequel to their acclaimed title Roterra: Flip the Fairytale. It continues that game's tradition of messing with which way is up, tasking you with solving... | Read more »
Hearthstone: Battlegrounds open beta lau...
Remember earlier this year when auto battlers were the latest hotness? We had Auto Chess, DOTA Underlords, Chess Rush, and more all gunning for our attention. They all had their own reasons to play, but, at least from where I'm standing, most... | Read more »
The House of Da Vinci 2 gets a new gamep...
The House of Da Vinci launched all the way back in 2017. Now, developer Blue Brain Games is gearing up to deliver a second dose of The Room-inspired puzzling. Some fresh details have now emerged, alongside the game's first official trailer. [Read... | Read more »
Shoot 'em up action awaits in Battl...
BattleBrew Productions has just introduced another entry into its award winning, barrelpunk inspired, BattleSky Brigade series. Whilst its previous title BattleSky Brigade TapTap provided fans with idle town building gameplay, this time the... | Read more »
Arcade classic R-Type Dimensions EX blas...
If you're a long time fan of shmups and have been looking for something to play lately, Tozai Games may have just released an ideal game for you on iOS. R-Type Dimensions EX brings the first R-Type and its sequel to iOS devices. [Read more] | Read more »
Intense VR first-person shooter Colonicl...
Our latest VR obsession is Colonicle, an intense VR FPS, recently released on Oculus and Google Play, courtesy of From Fake Eyes and Goboogie Games. It's a pulse-pounding multiplayer shooter which should appeal to genre fanatics and newcomers alike... | Read more »
PUBG Mobile's incoming update bring...
PUGB Mobile's newest Royale Pass season they're calling Fury of the Wasteland arrives tomorrow and with it comes a fair chunk of new content to the game. We'll be seeing a new map, weapon and even a companion system. [Read more] | Read more »

Price Scanner via MacPrices.net

New 2019 16″ MacBook Pros on sale for $100 of...
Apple Authorized Reseller Adorama has new 2019 16″ MacBook Pros on sale today for $100 off Apple’s MSRP, each including free shipping. In addition, Adorama charges sales tax for NY & NJ residents... Read more
Apple Watch Series 3 GPS models on sale for l...
Amazon has Apple Watch Series 3 GPS models on sale starting at only $179. There prices are the lowest we’ve ever seen for these models from any Apple reseller. Choose Amazon as the seller rather than... Read more
iOS Bug In Facebook News Feed Lets Device Ca...
NEWS: 11.15.19- Users of the Facebook social media platform’s mobile app running on iOS devices won’t, like, this piece of news one bit in where a bug in the News Feed gave access to the camera... Read more
16″ MacBook Pros on sale! Preorder at Amazon...
Apple’s new 16″ MacBook Pros were only introduced yesterday, but Amazon is already offering a $100 discount on preorders. Prices for the base 6-Core 16″ MacBook Pros start at $2299: – 2019 16″ 2.6GHz... Read more
Use our exclusive MacBook Price Trackers to f...
Our Apple award-winning MacBook price trackers are the best place to look for the best sales & lowest prices on new and clearance MacBook Airs and MacBook Pros–including Apple’s new 16″ MacBook... Read more
New November Verizon iPhone deal: Get an iPho...
Verizon has the 64GB iPhone Xr on sale for 50% off for a limited time, plus they will include a free $200 prepaid MasterCard and a free Amazon Echo Dot. That reduces their price for the 64GB iPhone... Read more
Apple cuts prices on clearance, refurbished 2...
Apple has clearance 2018 15″ 6-Core Touch Bar MacBook Pros, Certified Refurbished, now available starting at only $1829. Each model features a new outer case, shipping is free, and an Apple 1-year... Read more
Up to $450 price drop on clearance 15″ MacBoo...
B&H Photo has dropped prices Apple’s 2019 15″ 6-Core and 8-Core MacBook Pros by $400-$450 off original MSRP, starting at $1999, with free overnight shipping available to many addresses in the US... Read more
Here’s how to save $200 on Apple’s new 16″ Ma...
Apple has released details of their Education discount associated with the new 2019 16″ 6-Core and 8-Core MacBook Pros. Take $200 off the price of the new 8-Core model (now $2599) and $200 off the 16... Read more
Price drop! 2019 15″ 2.6GHz 6-Core MacBook Pr...
Focus Camera has dropped their price for clearance 2019 15″ 2.6GHz 6-Core Space Gray MacBook Pros by $400 to $1999 shipped. Apple’s original MSRP for this model was $2399. Focus charges sales tax for... Read more

Jobs Board

Best Buy *Apple* Computing Master - Best Bu...
**746655BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Store NUmber or Department:** 002518-Atlantic Center-Store **Job Description:** Read more
*Apple* Mobility Pro - Best Buy (United Stat...
**744973BR** **Job Title:** Apple Mobility Pro **Job Category:** Store Associates **Store NUmber or Department:** 000949-Rochester Hills-Store **Job Description:** Read more
AV Systems Engineer at *Apple* - Theorem, L...
Job Summary Apple Retail Technology is looking for an Audio Visual Systems Engineer to design and implement scalable, next-generation A/V solutions for Apple ?s Read more
Nurse Practitioner - Field Based (San Bernard...
Nurse Practitioner - Field Based (San Bernardino, CA, Apple Valley, Hesperia) **Location:** **United States** **New** **Requisition #:** PS30312 **Post Date:** 3 Read more
Best Buy *Apple* Computing Master - Best Bu...
**746510BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Store Associates **Store NUmber or Department:** 001407-Milford-Store **Job Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.