TweetFollow Us on Twitter

January 92 - Dinker: the Dynamic Linker

Dinker: the Dynamic Linker

Kurt Schmucker

Many application domains naturally possess an unbounded set of desired features. A signals processing application, for example, needs an unlimited number of filters. A symbolic math package, an unlimited number of mathematical operators. A graphics package, an unlimited number of sketching tools.

Of course, no real application can present an unlimited number of anything to any given user. However, the market as a whole does appear to want an unlimited number of features. What's a developer to do?

Some developers have met this challenge by building in a capability to extend their applications. Using this feature, end users can configure a graphics package, for example, with a set of sketching tools tailored to their needs, or even modify the set of available sketching tools while the application is running.

This enables users to get the maximum use of limited RAM and disk space. Instead of running in a six megabyte MultiFinder partition, for example, an extensible application, with only the needed tools loaded, could run in, say, four megabytes. In fact, one of the best selling MacApp applications, Adobe PhotoShop, uses an extensibility approach with their plug-ins to add new image manipulation algorithms and data access procedures to the application.

Up until now, MacApp has provided no support to those wanting to add extensibility to an application. To make matters worse, the most natural way to add functionality to a MacApp application-by adding new classes to the running application- was something no one had ever done. Some people even thought this was impossible to do on the Mac.

Dinker, the results of recent work by Apple's Advanced Technology Group, adds exactly this capability to MacApp. This article describes what Dinker does and how you can use it in your application. Other articles planned for later issues of FrameWorks will cover Dinker internals and case studies of adding Dinker-based extensibility to commercial MacApp applications.

Dinker is included on the next Essentials, Tools, and Objects CD (ETO 6) as a currently unsupported MacApp experiment. It will be demonstrated at the Orlando '92 MADA Conference in February.

What is Dinker?

Dinker is a dynamic linking mechanism for the Macintosh OS. It lets you write applications whose functionality can be extended at run-time by the addition of new Object Pascal or C++ classes. In particular, Dinker lets the MacApp programmer add new 'view' or 'VIEW' resources, new view classes, new command classes or any other classes at run-time, and to use instances of these classes just like any other object in the application.

The basic run-time architecture of a Dinker application is shown in Figure 1, and then in greater detail in Figure 2 (next page). Dinker will set up entry and exit points in the base and all extensions, and will ensure that the proper global environment (A5 worlds, resource chains, etc.) is established upon crossing the boundaries between the base and the extensions, or between extensions.

Building an application that can be extended at run time via the Dinker is easy. Tell the Dinker version of MABuild to build the application to make use of Dinker. Such an application is called a "base." Then, use MABuild to build each dynamically linkable extension for the application (called an "extension" or a "component"). The total Dinker package used by a MacApp programmer-Dinker itself, the Dinker-aware modified version of MacApp (either a modified version of MacApp 2.0.1, or a modified version of MacApp 3.0ß3), the Dinker-aware version of MABuild, etc.-will cause the entry and exit points to be constructed for the base and for all extensions, and will resolve, at run-time, the invocations of these references. (See future FrameWorks articles for an explanation of the Dinker's inner details.)

A note on terminology-Dinker is a dynamic linker. It lets you "dink in" a new class into a running application. Among dynamic linkers, Dinker is unique in that it enables the dynamic linking of new classes into an object oriented application, like a MacApp application. For a time, the term "oinking" was used to describe this dynamic linking, but this term has fallen into disfavor with the Dinker implementors. A later, supported version of Dinker may have a slick, marketing-approved, copyright-obtained legal name. We hope that all savvy MacApp developers will continue to call it "Dinker" in perpetuity.

What Does dynamic linking do for users?

MacApp developers are subject to the same pressures as every other developer-users want more and more functionality in applications without the resource requirements increasing.

Extensibility lets you achieve these opposing goals. Users can pick which tools to load in the default case (by, for example, placing these in a distinguished folder), yet still have easy access to the tool needed on special occasions. In this way, Dinker lets users manage the resources needed to run your application much like Fifth Generation System's Suitcase™ II lets the user manage fonts, desk accessories, FKEYs, and sounds.

In addition, for those developers who wish to encourage a third-party market surrounding their applications, Dinker provides a way for other MacApp developers to leverage off of your application by developing extensions for it. These third parties will need the entry and exit vector files the Dinker-modified version of MABuild prepares for the application. These could be part of a developer's kit for your application. Developers of extensions do not need access to the source code of the base.

How is dinker used in an application?

To use Dinker, you willl probably need to change your application's source; most applications aren't currently designed for extensibility. Do you have a fixed number of items in a palette-items that the end user may want to add to, or replace? Do you check, upon resuming after a MultiFinder switch, if the user has added functionality to the application "behind your back?" Probably not. There will be as many ways of designing extensibility into MacApp applications as there are clever MacApp programmers.

Automatic loading of components

One way of adding new functionality to an application is to have the user configure a folder with the desired extensions in it. Dinker supports this approach. (If this sounds vaguely like the System 7 Extensions folder, it is. The Finder Extensions mechanism used in System 7 is a special case of the full Dinker design.) The Dinker version of MacApp provides a number of ways to find out which extensions have been loaded. TApplication (in this modified version of MacApp) maintains a list of the currently loaded extensions, and several utility methods and procedures let you easily query this list.

One interesting technique uses a MacApp method that you probably haven't used before: ForAllSubClassesDo in TObject. I used this technique to add an indeterminate number of dinked-in views to a window. It just happened to be the case that while each of these new subviews was a instance of a different class, all the classes were subclasses of a class unique to my application (TBannerView). The code looks like this:

PROCEDURE TBannerDocument.DoMakeViews(…);  
                                                OVERRIDE;
    VAR theWindow:  TWindow;
        theFirstView:   TBannerView;
        currentLoc:     VPoint;
        aView:          TBannerView;
        
        PROCEDURE AddAView(theClass: ObjClassID);
        BEGIN
            currentLoc.v := currentLoc.v + 135;
            aView := TBannerView(NewObjectByClassID(theClass));
            FailNIL(aView );
            aView.IBannerView(…); { this will add it as subView }
        END;
        
    BEGIN
        SetVPt(currentLoc, 0, 0);
        
        { Prime the pump by setting up the window
            with the first view }
        theWindow := NewTemplateWindow(2222, SELF);
        FailNIL(theWindow);
        theFirstView := TBannerView(theWindow.FindSubView('MNBN'));
        
        { Now add the rest of the views }
        theFirstView.ForAllSubClassesDo(AddAView)
    END;

You could use the same technique to build a palette (when all the new tools to be configured into the palette are subclasses of something like TAbstractTool), or a hierarchical menu.

Manual loading of components

Another way to add functionality is to let the user load new components at any time the application is running. Dinker also supports this. One way you can use this support is to add the appropriate menu items to your application and to process these in a DoMenuCommand something like this code from the Dinker version of DrawShapes:
PROCEDURE TShapeApplication.DoMenuCommand(
            aCommandNumber: CommandNumber); OVERRIDE;
    VAR
        anExtensionFile:    TList;
        aDomain:            TDomain;
        r:                  Rect;
        shape:              TShape;
        toolsView:          TToolsPalette;
        toolsMenu:          TToolsMenu;

        PROCEDURE DoToItemInExtensionList(item: TObject);
    BEGIN
        aDomain := GetExtension ( TFile (item) );
        IF longint(aDomain) <> 0 THEN BEGIN
            { Define the prototype shape this component }   
            SetRect(r, 9, 49, 31, 71 );                     
            OffSetRect(r, 0, 40 * ( gShapesInPalette ) );
            shape := TShape ( Instantiate( aDomain ) );
            FailNil(shape);
            gShapesInPalette := gShapesInPalette + 1;
            shape.IShapeExtension(r, gShapesInPalette );
            gShapesArray[gShapesInPalette] := shape;
        END;
    END;
    
    PROCEDURE ForceWindowRedraw ( aWindow: TWindow );
    BEGIN
        aWindow.ForceRedraw;
    END;

    BEGIN
    CASE aCommandNumber OF
        ...
        cGetComponent:                      
            BEGIN
                IF ChooseDocument( cGetComponent, anExtensionFile )
                THEN BEGIN
                    anExtensionFile.Each( DoToItemInExtensionList );
                    anExtensionFile.Free;
                    { Now add the new shape to the palette }
                    toolsMenu := TToolsMenu(gToolsMenu);
                    IF longint(toolsMenu) <> 0 THEN
                        toolsMenu.AddTool;
                    ... { Add to Tear offs, etc. here }
                    ForAllWindowsDo( ForceWindowRedraw );
                END;
    
            OTHERWISE
            INHERITED DoMenuCommand(aCommandNumber);
    END; {Case}
END;

'lView' templates in extensions

Often, TView objects are not allocated explicitly by the programmer, but rather are instantiated indirectly via 'view' resources. Extensions also have their own resource chain (forked off of the top of the base's resource chain). You can put 'view' and 'VIEW' resources in your extension. The Dinker extensions to MacApp include Dinker analogs of the familiar utility routines NewTemplateWindow and DoCreateViews, NewComponentTemplateWindow() and DoCreateDinkedViews(), which you can then use to dink in these views from other extensions. Like the standard NewTemplateWindow , NewComponentTemplateWindow lets you access a view by its resource id. However, NewComponentTemplateWindow also lets you access the new window type by the name of the extension that contains it. We have found this to be a natural way to add new functionality to an application in the case that the "important" portion of the extension was the new views being added. In this application, we made the names of the extensions the same as the names of the view.

What are the Drawbacks of using Dinker?

There is no free lunch, and Dinker, too, has some costs. These costs are not in the area of performance. Using instances of dinked-in classes carries only a tiny performance hit on the application. The gotchas of the current Dinker implementation are as follows.

Launch time

Dinker applications take longer to launch than "normal" applications. Remember that Dinker is a dynamic linker. Thus, it is doing the work of the linker at run-time. The amount of time depends mostly on the Mac model you are executing on (no surprise here) and the version of MacApp you are using (remember that MacApp 3 has about twice the number of classes and methods of MacApp 2, and there is a lot more to link in a MacApp 3 application). The additional amounts of launch time can range from less than two seconds (FX, MacApp 2) to more than 30 seconds (Portable, MacApp 3). I hope that future versions of Dinker will be able to reduce these times, but they will never go to zero.

Extensions are application specific

The Dinker internals that make it the only dynamic linker that enables the addition of new classes at run-time also require that a built extension, ready for dinking, be application specific. In addition, any significant changes to the class structure of the application require that all the application's extensions be rebuilt.

What is "significant?" Addition or removal of classes, addition or removal of methods, addition or removal of any entities that the linker needs to know about (for example, invocation of a new Toolbox routine, or moving something from the private interface to the public interface) are prime examples. "Insignificant," from a Dinker point of view, are changes to the implementations of methods or functions that don't add or remove Toolbox calls.

Debugging support

The ease of debugging a Dinker application depends on whether MacApp is used, and what version of MacApp is used. The best case is MacApp 2.0.1. The two main debugging tools designed for MacApp 2.0.1, the Inspector and the MacApp Debugger, are fully integrated with Dinker. The dinked-in classes and any instances of these classes are viewable from these tools and, in fact, you'll have a hard time distinguishing between an instance of a dynamically linked class and a statically linked class. This was a goal of the Dinker implementation, and we believe it has been met (after a lot of hard work and many late night sessions double checking on this integration).

Unfortunately, the situation is not so rosy with respect to a MacApp 3.0ß3 application, or a non-MacApp application. Yes, you can use Dinker without using MacApp. However, it isn't as easy or as convenient, mostly because we planned the first Dinker release to concentrate on the use of Dinker by a MacApp programmer.

The new MABuild, for example, handles the complexity of building the entry and exit vector segments without any work by the MacApp programmer. There are currently no such automated build facilities for the non-MacApp developer. There isn't much debugging support in either SourceBug or SADE® for dynamically linked extensions. Basically, neither of these tools yet know how to read the multiple SYM files associated with the base and all of its currently dinked in extensions, nor do they know to reassess a class hierarchy that has been modified dynamically by Dinker. However, that doesn't mean these debugging tools are useless with a Dinker application. You can use SourceBug with Dinker applications, but with these limitations:

  • SourceBug is confused by the new Class hierarchy that Dinker creates. So SourceBug's browser displays the source code filenames of the base and of the MacApp library rather than its classes.
  • SourceBug only really knows about the code in your base. You must go into your low level debugger if you want to step into your extension.

I hope that these limitations will be removed in the future.

Finally, a goal of Dinker was to require only minimal-and preferably pro forma-changes to a class to change it from being a statically linked piece of functionality to one that could be dynamically linked into the application. We believe this goal has been met. Thus, one possible debugging strategy is to develop and debug your application as a monolithic, statically linked application, and then when it is "bug free," to peel off various pieces of functionality into dynamically linked extensions. (Okay, okay. We know that this is kind of lame, and that your testing manager just had a heart attack even considering this approach. But it's better than nothing, and this is only the early experimental release.)

Support, in general

The Dinker ETO #6 release is an unsupported, experimental release, but Dinker or other dynamic linking mechanisms may be incorporated into future releases of MacApp, MPW, or other development tools.

While it is implemented according to the same architecture as Finder Extensions, Dinker adds significant new dynamic linking functionality to Finder Extensions and thus an extended period of testing is needed. The Dinker work was done by Apple's Advanced Technology Group and is being shared with third-party developers for experimentation and evaluation. If you find dynamic linking to be a useful feature, then it may be supported and extended in future MacApp and MPW releases. Let us know by sending an AppleLink message to the Dinker Product Manager, Tom Chavez (TOM.CHAVEZ).

FUTURE FRAMEWORKS ARTICLES

How Dinker works, and what it is like to add extensibility to an existing commercial MacApp application, will be covered in detail in future FrameWorks articles.

Acknowledgements

The Dinker folder on ETO #6 is the result of many months of work by employees from several parts of Apple, as well as some Apple contractors. Jed Harris, then in ATG, now in the Developer Tools group, did the original Dinker design. He and Scott Douglass, now in the System Software group at Apple, implemented the first proof of concept that Dinker would actually work. Frank Kurzawa of Refried Software, and Andrew Donoho of Donoho Design Group did the current Dinker implementation under contract to ATG. Frank also designed and implemented the changes to MacApp 2.0.1 and MacApp 3.0ß3 that make it work with Dinker, and he did many of the Dinker sample programs. Joost Kemink and Kurt Schmucker, both of ATG, were the "typical" Dinker users whose dinking needs drove the design, and who did all the testing of Dinker with MacApp. Kurt Schmucker was the author of two of the Dinker sample programs. Tom Chavez is the Dinker Product Manager and guided the Dinker work onto ETO.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

BusyCal 3.1.7 - Powerful calendar app wi...
BusyCal is an award-winning desktop calendar that combines personal productivity features for individuals with powerful calendar sharing capabilities for families and workgroups. Its unique features... Read more
Lyn 1.8.9 - Lightweight image browser an...
Lyn is a fast, lightweight image browser and viewer designed for photographers, graphic artists, and Web designers. Featuring an extremely versatile and aesthetically pleasing interface, it delivers... Read more
Tweetbot 2.5 - Popular Twitter client.
Tweetbot is a full-featured OS X Twitter client with a lot of personality. Whether it's the meticulously-crafted interface, sounds and animation, or features like multiple timelines and column views... Read more
Monolingual 1.7.8 - Remove unwanted OS X...
Monolingual is a program for removing unnecesary language resources from OS X, in order to reclaim several hundred megabytes of disk space. If you use your computer in only one (human) language, you... Read more
Dash 4.0.3 - 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
Posterino 3.3.6 - Create posters, collag...
Posterino offers enhanced customization and flexibility including a variety of new, stylish templates featuring grids of identical or odd-sized image boxes. You can customize the size and shape of... Read more
Apple Numbers 4.1.1 - Apple's sprea...
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
Apple Pages 6.1.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
iClock Pro 3.4.9 - Customize your menuba...
iClock Pro is a menu bar replacement clock for Apple's default clock. iClock Pro is an update, total rewrite and improvement to the popular iClock. Have the day, date and time in different fonts and... Read more
Typinator 7.2 - 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

Latest Forum Discussions

See All

Get up to speed with everything you need...
In case you haven’t heard, MU Origin just got a colossal new update with new all-server events, battle modes, and systems making their way to the land of MU. Here’s a handy guide to everything you need to know about the latest content. [Read... | Read more »
Minimalist puzzle game, Cuts, free on iO...
If you're looking for a gorgeous puzzle experience on iOS devices, developer Gamebra.in's aesthetically interesting puzzler, Cuts, is discounted to free on the iOS App Store right now. [Read more] | Read more »
Anime tactical RPG, War of Crown, comes...
If you're looking for another tactical RPG fix to go alongside your Fire Emblem Heroes campaigns check out Gamevil's newest, anime-inspired tactics RPG, War of Crown, which comes out tomorrow. [Read more] | Read more »
Fantasy MMORPG MU Origin adds new modes,...
MU Origin, Webzen’s highly popular fantasy MMORPG is getting ready to shake things up for the second time this year, as a new update makes its way to the Google Play and App Store from today. Introducing new systems, modes, and events, the land of... | Read more »
Blizzard is looking to hire a mobile dev...
A new thread on the popular video game rumor forum, NeoGAF, uncovered an interesting job listing over at Blizzard Entertainment. It appears the studio behindStarCraft, World of WarCraft, Hearthstone,andOverwatch is looking to bring on a new hire... | Read more »
Legend of Zelda meets Cooking Mama in ne...
Dungeon Chef is what happens when you mix the RPG elements (and style) of a Legend of Zelda game, with cooking elements. Although, now that The Legend of Zelda: Breath of the Wild also has cookingelements, so maybe the gameplay is not so novel.... | Read more »
ChordFlow (Music)
ChordFlow 1.0.0 Device: iOS Universal Category: Music Price: $6.99, Version: 1.0.0 (iTunes) Description: ChordFlow is a chord sequencer with a unique 4-track polyphonic arpeggiator, extensive chord library, MIDI out and Ableton Link... | Read more »
The Walking Dead: A New Frontier is out...
The newest season of Telltale Games'The Walking Dead is well underway. After the release of the third episode, "Above the Law" about a month ago, episode four, "Thicker Than Water" is hot and ready for more zombies and gut-wrenching emotional... | Read more »
Best games we played this week
Another week, another new wave of mobile games do dive into. We've dug through the list of apps that came out this week to tell you which apps are worth your sweet time. And while there weren't too many games this week, there were some big ones.... | Read more »
Vignettes (Games)
Vignettes 1.0.1 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.1 (iTunes) Description: Vignettes is a casual but unique exploration game without text or characters, where objects shapeshift as you spin them around... | Read more »

Price Scanner via MacPrices.net

Digital Paper Tablet Offers Distraction Free...
I typically spend 8-10 hours a day gazing at the screens in my laptops and iPad, as tools of my livelihood, I don’t as a rule use electronic devices for pleasure reading. I subscribe to a daily... Read more
“Today at Apple” Bringing New Educational Ses...
Apple has announced plans to launch dozens of new educational sessions next month in all 495 Apple Stores ranging in topics from photo and video to music, coding, art and design, and more. The hands-... Read more
Smart Finance Free Comprehensive Personal Fin...
Moscow-based indie developer, Alexander Survillo has announced the release and immediate availability of Smart Finance: Personal Finance, Budget & Money 1.1.4, an update to his comprehensive... Read more
12-inch 1.1GHz Retina MacBooks on sale for $1...
B&H has 12″ 1.1GHz Retina MacBooks on sale for $100 off MSRP. Shipping is free, and B&H charges NY & NJ sales tax only: - 12″ 1.1GHz Space Gray Retina MacBook: $1199.99 $100 off MSRP - 12... Read more
13-inch 2.7GHz Retina MacBook Pro on sale for...
B&H Photo has the 13″ 2.7GHz Retina MacBook Pro on sale for $130 off MSRP. Shipping is free, and B&H charges NY & NJ tax only: - 13″ 2.7GHz/128GB Retina MacBook Pro (MF839LL/A): $1169 $... Read more
15-inch 2.2GHz Retina MacBook Pros available...
B&H Photo has the 15″ 2.2GHz Retina MacBook Pro available for $200 off MSRP including free shipping plus NY & NJ sales tax only: - 15″ 2.2GHz Retina MacBook Pro (MJLQ2LL/A): $1799.99 $200 off... Read more
13-inch Touch Bar MacBook Pros on sale for up...
B&H Photo has the 2016 Apple 13″ Touch Bar MacBook Pros in stock today for up to $150 off MSRP. Shipping is free, and B&H charges NY & NJ sales tax only: - 13″ 2.9GHz/512GB Touch Bar... Read more
Apple refurbished Apple TVs available for up...
Apple has Certified Refurbished 32GB and 64GB Apple TVs available for up to $30 off the cost of new models. Apple’s standard one-year warranty is included with each model, and shipping is free: -... Read more
12-inch 1.2GHz Retina MacBooks on sale for up...
B&H has 12″ 1.2GHz Retina MacBooks on sale for up to $160 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 12″ 1.2GHz Space Gray Retina MacBook: $1439.99 $160 off MSRP - 12″ 1... Read more
HyperX Ships Pulsefire FPS Gaming Mouse, Winn...
Your reporter is a longtime fan of gaming mice for general purpose coomnputing use, finding them typically superior in comfort and performance. HyperX, a division of Kingston Technology Company, Inc... Read more

Jobs Board

Product Manager, *Apple* Platforms - Viacom...
…Product Manager to drive the execution of its iOS and AppleTV experiences. The Apple Platform Product Manager will be a leader in our Agile/Scrum environment and Read more
Geek Squad *Apple* Master Consultation Agen...
**500662BR** **Job Title:** Geek Squad Apple Master Consultation Agent **Location Number:** 000286-Canton-Store **Job Description:** **What does a Geek Squad Read more
*Apple* Mobile Master - Best Buy (United Sta...
**500710BR** **Job Title:** Apple Mobile Master **Location Number:** 000279-North Olmsted-Store **Job Description:** **What does a Best Buy Apple Mobile Master Read more
*Apple* Engineering Specialist - CSRA (Unite...
Apple Engineering Specialist All times are in Eastern Daylight Time Requisition ID Job Locations US DC Washington DC Posted Date Category Engineering Sciences Read more
*Apple* Mac Computer Technician - GeekHampto...
…complex computer issues over the phone and in person? GeekHampton, Long Island's Apple Premium Service Provider, is looking for you! Come work with our crew Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.