TweetFollow Us on Twitter

Dynamic Bundles Volume Number: 17 (2001)
Issue Number: 1
Column Tag: Mac OS X

Dynamic Bundles and Runtime Loading in OS X

By Andrew C. Stone

The Subtitle in Italics

As an application gets larger and more complex, the end user may perceive that the application loads slowly. Of course one can throw faster and multiple CPUs at the problem, but if you take advantage of dynamic bundle loading, your application can grow in functionality, but the time to launch remains lightning quick. How is this done? Simply by only loading the resources the user really needs at the moment. This article will show you how to architect your application to take advantage of bundles and late-loading.

Consider the fact that a typical application may have dozens of special panels and facilities that are occasionally accessed by the end user. There is no reason to load either the code or the resources for these panels until the end user actually requests that functionality.

There are many advantages to an application that dynamically loads bundles besides just fast launches. For example, in Stone Create, not only are all the inspectors, panels, and editors loaded on demand, but there is also a facility to load new tools at runtime. Any bundles found in the Tools directory are loaded and added to the tool palette when a new document is created. For example, the "Star" and "Embed" objects are loaded this way. New tools can be created and added without Create knowing anything about these in advance. By creating and adhering to protocols, which are sets of methods that must be implemented by an object, your application can deal with brand new objects at runtime.

The CFBundle, and its Cocoa cover class, NSBundle, handle all the details of locating and loading resources on demand. Most developers just use these for user interfaces, images, sounds and resource files, but it's simple to also load code on demand. The question then becomes, "how can I refer to code that is not yet loaded?" and "how can I compile code that has unresolved symbols"?

PreferencesController Bundle Example

One feature which makes OS X applications so powerful is the ease of user customization through the NSUserDefaults mechanism. Therefore, most applications require a user interface for preferences, but why load this panel and the code which controls it before it's absolutely needed if at all? We'll use the example of a preferences panel as a likely target for "bundling". The object "PreferenceController" is an NSWindowController subclass, which knows how to return a single instance of itself with a factory method, +sharedInstance:, because there is only one preferences panel in any application:

+ (id)sharedInstance {
    static PreferencesController *sharedPreferences = nil;

    // the first time through, we get the singleton preferences controller:
    if (!sharedPreferences) {
         sharedPreferences = [[PreferencesController                            allocWithZone:NULL] init];
    }

    return sharedPreferences;
}

Our dynamic loading code will assume that every bundle responds to "+ sharedInstance" if there are only one of these objects (for example, there is only one Color panel per application).

If PreferenceController is linked into the application, you would have a method to bring up the panel in your application delegate object:

- (IBAction)showPreferencesPanelAction:(id)sender {
   [[PreferenceController sharedInstance] showWindow:self];
}

but then, that code would be loaded at the launch of the application, because it has to be compiled into the application's binary since it is referenced by name. The way we move to a dynamicly loaded model is to never refer to this class, except in a string as an argument to our dyamic loading method sharedInstanceOfClassName:, which appears later in the article:

    [[self sharedInstanceOfClassName:@"PreferencesController"] showWindow:self];

Now, the code will compile without including the PreferencesController class. Our job is to be sure it gets loaded when first needed. Typically, I add the bundle loading code to the NSApplication's delegate, which can be globally accessed with:

[NSApp delegate]

Another strategy, and a topic of a later article, is to use categories, and add that functionality right to the NSBundle class. I prefer using the NSApp's delegate because you can add cover methods for loading panels in a single class, and then connect menu items to the instantiated application delegate in the application's main NIB file. So, in this example, we would:

  1. add a method to the NSApp delegate class:
    - (IBAction)showPreferencesPanelAction:(id)sender;
    
  2. In InterfaceBuilder, connect the menu item "Preferences..." to the app delegate target, with the action "showPreferencesPanelAction:". You can quickly add actions to IB by dragging in the .h or .m file from ProjectBuilder into the document window of your nib. This is equivalent to "Classes->Read File...".
  3. When that menu item gets triggered, the application delegate will load the needed code. Subsequent invocations of the panel will be even swifter, but loading a single panel and controller code is pretty fast anyway.

Bundle Integration in Project Builder

From a Project Builder standpoint, your application's project becomes an aggregate of targets: the application target, and a target for each of the dynamically loaded bundles. Your application should add the product of each bundle to the Copy Files phase in the "Files and Build Phases" tab of the application target inspector.


Figure 1. Copy files phase adds bundles to the application target.

For backwards compatibility with OpenStep, I use the "Resources" directory to store bundles. The following code assumes that you are putting your bundles into the Resources subdirectory in <YOUR_APP_NAME>.app/Contents/. You change where they are copied to with the "Where:" pop-up in the Files & Build Phases pane of the Target Inspector. It is probably more intuitive to place bundles in "Bundles" subdirectory, and if you do, change the pathForResource:ofType: call to pathForBundle:ofType: in the method -(id)instanceOfClassName:(NSString *)name shared:(BOOL)shared.

Before looking at the very simple dynamic loading code, there is one point to consider. A Cocoa bundle has the notion of a principal class. That is the class that is both the owner of the NIB file, and the class that needs to be accessed first when the bundle is loaded. Many times, a bundle will only have one class in it, but its a potential gotcha to not specify the principal class if there are more than one class in the bundle. You assign the principal class in Project Builder - click the bundle target to load the target inspector. Select the "Bundle Settings" tab, and under the "Cocoa Specific" settings, type in the name of the class in the Principal class field, in this example, PreferencesController. Other fields let you assign version information, help files, main nib files, but these are optional.

The Dynamic Loading Code

The code offers two types of dynamic code loading - both singleton class instances such as the PreferencesController with sharedInstanceOfClassName, as well as simple new instances for each invocation with instanceOfClassName. Both use the same core code with a "shared" flag:

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

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

instanceOfClassName would be used, for example, in a document-based architecture application where each document had its own version of that bundle's nib. An example would be a sheet that gets run on a per-document basis - because more than one document can be in a sheet-modal state at the same time. In this case, the document becomes responsible for freeing the bundle resources upon closing. Singleton instances are not freed until the application quits.

- (id)instanceOfClassName:(NSString *)name shared:(BOOL)shared
{
    id obj = nil;
    // NSBundle does the work of finding the bundle
    // pathForResource means "look into Resources folder"
    // use pathForBundle if you store them in the "Bundles" folder
    NSString *path = [[NSBundle mainBundle] 
                              pathForResource:name ofType:@"bundle"];
    if (path) {
        NSBundle *b = [[NSBundle allocWithZone:NULL] 
                                                   initWithPath:path];

        // the object we wish to return is an instance of the principal class:
        if ((b != nil) && ([b principalClass] !=NULL)) {

      // we either grab the sharedInstance or create a new one:
      if (shared) obj = [[b principalClass] sharedInstance];
      else obj = [[[b principalClass] allocWithZone:NULL] init];

    // provide Developer feedback if something has gone wrong:
        }  else NSLog(@"Can't Load %@!\n", path);
    } else NSLog(@"Couldn't find %@ bundle!\n",name);

    return obj;
}

Conclusion

When designing your application, it is good practice to decompose your functionality into small, loadable pieces. By using dynamically loaded bundles, you gain launch speed and can take advantage of runtime binding for loading new tools. Probably most importantly, bundles create a firm foundation for future feature growth without application bloat as well as provide a natural modularity that is easy to comprehend.


Andrew Stone <andrew@stone.com> is CEO of www.stone.com and has been working with Cocoa since 1989 with its introduction as NeXTStep.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Dropbox 193.4.5594 - Cloud backup and sy...
Dropbox is a file hosting service that provides cloud storage, file synchronization, personal cloud, and client software. It is a modern workspace that allows you to get to all of your files, manage... Read more
Google Chrome 122.0.6261.57 - 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
Skype 8.113.0.210 - Voice-over-internet...
Skype is a telecommunications app that provides HD video calls, instant messaging, calling to any phone number or landline, and Skype for Business for productive cooperation on the projects. This... Read more
Tor Browser 13.0.10 - Anonymize Web brow...
Using Tor Browser you can protect yourself against tracking, surveillance, and censorship. Tor was originally designed, implemented, and deployed as a third-generation onion-routing project of the U.... Read more
Deeper 3.0.4 - 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
OnyX 4.5.5 - Maintenance and optimizatio...
OnyX is a multifunction utility that you can use to verify the startup disk and the structure of its system files, to run miscellaneous maintenance and cleaning tasks, to configure parameters in the... Read more
Hopper Disassembler 5.14.1 - Binary disa...
Hopper Disassembler is a binary disassembler, decompiler, and debugger for 32- and 64-bit executables. It will let you disassemble any binary you want, and provide you all the information about its... Read more
WhatsApp 24.3.78 - Desktop client for Wh...
WhatsApp is the desktop client for WhatsApp Messenger, a cross-platform mobile messaging app which allows you to exchange messages without having to pay for SMS. WhatsApp Messenger is available for... Read more
War Thunder 2.33.0.135 - Multiplayer war...
In War Thunder, aircraft, attack helicopters, ground forces and naval ships collaborate in realistic competitive battles. You can choose from over 1,500 vehicles and an extensive variety of combat... Read more
Iridient Developer 4.2 - Powerful image-...
Iridient Developer (was RAW Developer) is a powerful image-conversion application designed specifically for OS X. Iridient Developer gives advanced photographers total control over every aspect of... Read more

Latest Forum Discussions

See All

Gorgeous Tactical Puzzle Game ‘Howl’ is...
Following its release on PC and Nintendo Switch this past November, and it’s arrival on Xbox and PlayStation back in January, publisher Astragon Entertainment and developer Mi’pu’mi Games are now bringing their super stylish tactical puzzler Howl to... | Read more »
Best iPhone Game Updates: ‘Shoot the Moo...
Hello everyone, and welcome to the week! It’s time once again for our look back at the noteworthy updates of the last seven days. It feels like a bit of a dry spell this week, at least in terms of really interesting updates. I mean, I found some... | Read more »
Celebrate Phobies spooky second annivers...
Get ready to have that classic song stuck in your head, as Phobies celebrates its second anniversary with the release of its latest update; Birthday Bash, Monster Mash. Starting March 5th and lasting for four weeks, it will be a month of... | Read more »
‘Dissidia Final Fantasy Opera Omnia’ Sto...
Square Enix finally shut down Dissidia Final Fantasy Opera Omnia (Free) on iOS and Android last week following the end of service announcement back in November last year. Following the game shutting down, Square Enix | Read more »
‘Monster Hunter Now’ Is Celebrating the...
Niantic and Capcom have begun celebrating the 20th anniversary of Capcom’s best franchise from today inside Monster Hunter Now (Free) on iOS and Android for a limited time. | Read more »
New ‘Warframe Mobile’ Update Adds 60fps...
Warframe Mobile (Free) launched worldwide on iOS just under two weeks ago. I’ve been playing it for review across multiple iOS devices, but have also been picking it up on Steam Deck and Switch to compare. Right from launch, I was impressed with... | Read more »
Passionate About Fidget Toys – The Touch...
In this week’s episode of The TouchArcade Show we kick things off with some passionate discussion about… fidget toys? For some reason? We quickly change gears to talk about the card-based rogulike Balatro, which we’ve both been playing and enjoying... | Read more »
TouchArcade Game of the Week: ‘Flying Ta...
For me Hexage is one of those developers that harkens back to the early days of the App Store and really the beginnings of iPhone gaming. I have spent many collective hours playing the likes of Totemo, Radiant, Radiant Defense, EVAC, Reaper… the... | Read more »
SwitchArcade Round-Up: ‘Ufouria 2: The S...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for March 1st, 2024. In today’s article, we’re looking at the remaining releases of the week. There are a few really good ones today, but the bin bunch certainly isn’t going home hungry... | Read more »
Steam Deck Weekly: Reviews of PowerWash...
Welcome to the first Steam Deck Weekly of March and this week’s edition is bigger than usual. I was a bit unwell last week and had to push some reviews to this week. Alongside that, there have been many notable announcements, releases, and new Steam... | Read more »

Price Scanner via MacPrices.net

Apple discontinues 15-inch M2 MacBook Airs, d...
With today’s introduction of new M3-powered 15″ MacBook Airs, Apple has dropped prices on clearance, Certified Refurbished, 15″ M2 MacBook Airs to a new low of $1019. These are the cheapest 15″... Read more
Price Drop! 13-inch M2 MacBook Airs at Apple...
Apple has dropped prices on Certified Refurbished 13″ M2 MacBook Airs to a new low of $849. These are the cheapest M2-powered MacBooks for sale at Apple. Apple’s one-year warranty is included,... Read more
Apple finally discontinues the 13-inch M1 Mac...
With the introduction of M3-powered 13″ MacBook Airs today, Apple has dropped prices on clearance 13″ M1 MacBook Airs, Certified Refurbished, to $759 for 8-Core CPU/7-Core GPU/256GB models and $929... Read more
Updated Apple iPad Price Trackers
Our Apple award-winning iPad Price Trackers are the best place to find the latest information on iPad sales and deals. We track prices from 20+ Apple retailers, including Apple, Amazon, Best Buy,... Read more
Updated Apple MacBook Price Trackers
Our Apple award-winning MacBook Price Trackers are continually updated with the latest information on prices, bundles, and availability for 16″, 14″, and (recently-discontinued) 13″ MacBook Pros... Read more
Mac Studios with Apple M2 Max and M2 Ultra CP...
B&H Photo has the standard-configuration Mac Studio model with Apple’s M2 Ultra CPU in stock today and on sale for $300 off MSRP, now $3699 (24-Core CPU and 64GB RAM/1TB SSD). B&H Photo has... Read more
Extended: Switch to Verizon and get the Apple...
Verizon has the iPhone 15 on sale for $0 per month when you add a new line if service. Discount is applied to your account monthly over a 36 month term and is valid for the 128GB model. For the first... Read more
Select 16-inch M3 Pro and M3 Max MacBook Pros...
B&H Photo has select 16-inch M3 Pro and M3 Max MacBook Pros on sale for $250 off MSRP. Their prices are the lowest currently available for these configurations. Free 1-2 day shipping is available... Read more
27-inch Apple Studio Displays on sale for $10...
B&H Photo has 27″ Apple Studio Displays on sale for $100 off MSRP today. Free 1-2 day shipping is available to most US addresses: – Studio Display (Standard glass, Tilt stand): $1499 $100 off... Read more
iPad Airs return to their all-time lowest pri...
Best Buy has 10.9″ M1 WiFi iPad Airs on record-low sale prices again for $150 off Apple’s MSRP, starting at $449. Sale prices for online orders only, in-store price may vary. Order online, and choose... Read more

Jobs Board

Teller Part Time *Apple* Valley MN *Apple*...
…is not eligible for Visa sponsorship **Posting Location:** + 15574 Pilot Knod Road Apple Valley, MN 55124 @RWF22 **Posting End Date:** Job posting may come down Read more
*Apple* End User Support Specialist - North...
…that they are performed. + Responsible for support of all College owned Apple computers, mobile ios devices, and peripherals, and for diagnosing and resolving Read more
Omnichannel Associate - *Apple* Blossom Mal...
Omnichannel Associate - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Read more
Teller Part Time *Apple* Valley MN *Apple*...
…is not eligible for Visa sponsorship **Posting Location:** + 15574 Pilot Knod Road Apple Valley, MN 55124 @RWF22 **Posting End Date:** Job posting may come down Read more
Nurse Anesthetist - *Apple* Hill Surgery Ce...
Nurse Anesthetist - Apple Hill Surgery Center WellSpan Medical Group, York, PA | Advanced Practice Providers | Certified Registered Nurse Anesthetists | FTE: 1 | Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.