TweetFollow Us on Twitter

Libraries On The Mac

Volume Number: 14 (1998)
Issue Number: 6
Column Tag: Tools Of The Trade

Libraries on the Mac

by Jeremy Nelson

An overview of shared code mechanisms on the Macintosh

Libraries - precompiled collections of code - are a powerful tool for programmers. They allow us to distribute valuable technologies without disclosing the secrets of the proprietary source code from which those libraries were created. Because libraries are precompiled, they also encourage users of the technology to treat them as a black box - letting the user focus on their own code without worrying how library accomplishes its purpose. This article will survey library mechanisms on the Macintosh and offer a brief overview of the advantages of each.

Statically Linked Libraries

Libraries can be linked to other code statically or at runtime. A statically linked library, like code you have written yourself, is integrated into your application's binary during the compilation process. In contrast, a runtime library is loaded when the application executes, and calls made to the library are redirected to the loaded code. Both kinds of libraries are a good way to share new technologies.

Statically linked libraries are made up of a precompiled binary and an interface file which contains the API. Using a statically linked library is easy, simply include the binary and the C header file or Pascal interface file. During the linking stage of compilation the binary portion of the library is integrated into your application, exactly like the compiled code of the source you have written.

Most programs include some statically linked libraries. These libraries may provide language specific functions, basic Macintosh calls or mathematical functions.

Runtime Libraries

Runtime libraries, also known as Dynamically Linked Libraries (DLL), can reduce disk usage and lower memory requirements by allowing different applications to share a single copy of the code. Runtime libraries can also allow portions of an application to be selectively updated by simply replacing an old library file with a newer one.

Like statically linked libraries, runtime libraries are composed of a binary and an interface file. However the binary is simply a stub library which contains the names of the functions and version information. Mercifully, exactly how the functions are made available to your program when the program is executed is hidden from you. During your programs initialization phase, when your program is being readied to execute, the Operating System prepares any Shared Libraries you reference.

There are a variety of Shared Library mechanisms on the Mac, each with strengths and weakness. This diversity of library mechanisms exists largely due to historical factors. The formal library mechanisms are:

  • Apple Shared Library Manager (ASLM)
  • Code Fragment Manager (CFM and CFM-68K)
  • System Object Model (SOM)

For completeness, any discussion of shared code mechanisms also needs to include:

  • Component Manager
  • Code Resources

Custom mechanisms are also perfectly valid (if possibly application specific) ways of sharing code. Creating a custom mechanism allows developers to tailor a solution, but at the risk of recreating already tried and tested code- a somewhat ironic result.

Apple Shared Library Manager (ASLM)

ASLM is the one of the oldest solutions from Apple and it works under 68K and PPC. Unfortunately you can only make the libraries with MPW. While ASLM is available on every Mac and fairly straightforward to use, very little uses ASLM besides Open Transport 68K. Most programmers will never use ASLM directly.

Example: OpenTransport 68K.

Reference: ASLM Developer's Guide, Developer CD Series Mac OS SDK.

System Object Model (SOM)

SOM was developed by IBM to work on their AIX systems, runs under OS/2 and was ported to the Mac as part of the development of OpenDoc. SOM is both PowerPC and 68K and is probably the most technically advanced solution on the Macintosh. It is also a deprecated technology and as such it will probably not progress in the future.

SOM provides a number of desirable features. It can handle different calling conventions between caller and callee, and there are standard ways to patch and unpatch the code dynamically (so you can intercept a library call with your code). It even tackles the so-called 'fragile base class' problem and other changes to the interface of a library. SOM provides the calling program with full Object Oriented class libraries, even translating across different compilers' Object implementations.

While SOM is a technically wonderful solution it is a complex technology which has been quite difficult to use. Development tools have now reduced this difficulty somewhat. SOM was deprecated along with OpenDoc.

Examples: Opendoc and Cyberdog.

Reference: SOMobjects(tm) for Mac OS, Developer CD Series Mac OS SDK.

Code Fragment Manager (CFM and CFM-68K)

CFM was made specifically for PowerPC: when the PowerPC system came out there was no native shared library, so Apple developed a PowerPC native library format. CFM is used by both ASLM and SOM to load code fragments on the PowerPC.

In 1994 CFM was ported to 68K to provide a universal solution. CFM-68K had stability problems which discouraged its use for some time. This was fixed in version 4.0 of CFM-68K in November 1996 (as described in Technote 1084).

To use CFM-68K you need to use different versions of the runtime libraries, specially modified to work with CFM-68K. This makes your application a 'CFM-68K application', and you need to be careful about using custom preemptive threading methods (this problem relates to the version 4.0 bug fix mentioned above). (It is possible, but tricky, to call CFM-68K code from classic applications. See Technote 1077 for details.)

CFM is Apple's announced direction in shared code. There are good development tools for CFM in both CodeWarrior and MPW. If you were developing a library for a PowerPC application this should be your preferred choice. Under 68K some developers may be discouraged from adopting CFM-68K applications because of the changes necessary to their application.

Example: OpenTransport, MathLib, AppearanceLib.

References: IM PowerPC System Software, Chapter 3: Code Fragment Manager.

Component Manager

The Component Manager was written by the QuickTime team to meet their need for a universal plug-in architecture. As a result, the Component Manager is available under both 68K and PPC.

Components are code fragments with a particular type (like File Types in the file system). All components of the same type have the same interface. This allows applications to chose from a list of different code fragments, each of which may have different behaviour, but can be loaded and used identically. This is equivalent to having multiple different versions of a single library, each with different performance characteristics.

Components can also be captured which permits functions to be overridden and modified. A captured component is removed from the list of available components, but can still be called by the capturing component.

The drawback is that this added versatility introduces additional complexity. Applications must deal with selecting and loading the component: the code is not loaded automatically when the program is being loaded.

QuickTime is the most obvious user of the Component Manager. An interesting user of the Component Manager is Internet Config. When Internet Config was written this was the only solution which worked well under PowerPC and 68K, and provided the override functionality, which was a desired feature of Internet Config.

Examples: QuickTime, Internet Config.

Reference: IM More Toolbox, Chapter 6: Component Manager.

Code Resources

The most common example of code resources are List Definition Functions (LDEF), Window Definitions Functions (WDEF) and Control Definition Functions (CDEF). These are functions which are loaded using the Resource Manager. It is up to the programmer to define the API and the program is responsible for loading and unloading the code.

Typically Code Resources only have a single entry point (function call) with an argument which selects the actual function and a small number of other arguments, often contained in a parameter block. Which values are extracted from the parameter block may depend on what function is called.

Code Resources have been used in a number of applications and good example code is available. For instance, on the Code Warrior Pro 2 CD, the "Pascal Code Resources" shows how to create 68K or PPC code resources, either of which can be called from both 68K and PowerPC applications. (This is a useful way to update time-critical portions of a 68K application to run under PowerPC without updating the entire application.)

Examples: LDEFs, CDEFs, Codewarrior Plug-Ins under 68K.

Reference: IM More Toolbox, Chapter 1: Resource Manager.

Dangers

Probably the most confusing thing about libraries is that the binary can be compiled using a variety of different compiler options. Thus there are usually many different versions of any given library. For a splendid example of this, look in Codewarrior's MSL C:Bin folder. There are over a dozen different versions of the Metrowerks Standard C library (MSL C for 68K).

You need to make sure you include the appropriate version of the library in your code. You will not always get compiler warnings if you include the wrong version, and some mismatched program/library compiler settings can lead to intermittent errors which may be very difficult to debug.

There are several common compiler options unique to 68K which result in different versions. The main settings include:

  • Near or Far: Under 68K calls to functions can use so called 'Near' or 'Far' references.
  • 2i or 4i: Two or four byte integers. You need to be careful here since it is easy to include the wrong version, you will not get an error when the application is compiled, and it can result in obscure bugs which are hard to track down.

The PowerPC Runtime Architecture is much more precisely defined than under 68K. For example, under PowerPC all code references use the same convention and all integers are four bytes. As a result there are usually many fewer versions of the PowerPC library.

Different compilers can also generate different implementations of the same library. This is because the calling conventions for the functions (such as how the function parameters are ordered on the stack) are not generally defined by the language so it is up to the compiler vendors to choose. One good way around this is to export functions using the 'pascal' keyword. The Pascal calling conventions are well defined, so libraries compiled this way will work under different compilers and with different languages (all other options being equal).

It is also advisable to avoid the 'int' integer type in the library interface, instead use 'Int16' or 'Int32'. This gives more robustness across different compilers, languages and environments.

Conclusion

Libraries provide conceptually clean interfaces to code, which can be well tested and re-used. They can also lower compile time and allow large projects to be factored into smaller chunks. Runtime libraries provide additional benefits such as reduced disk and memory overhead, plus they can provide novel functionality through dynamic patching.

On the Macintosh under PowerPC the Code Fragment Manager is Apple's announced direction in shared code, has good tool support and is relatively easy to use. CFM is guaranteed to exist on all PowerPC Macs.

Unfortunately CFM-68K requires additional effort on behalf of programmers who wish to utilise CFM-68K libraries and CFM-68K support is not always present on older Macintoshes. For this reason Code Resources are often used as a relatively straightforward library mechanism.


Jeremy Nelson is a programmer and Technical Support Droid for Stairways Software Pty Ltd.

 
AAPL
$529.08
Apple Inc.
-2.62
MSFT
$39.63
Microsoft Corpora
-0.36
GOOG
$531.17
Google Inc.
-3.64

MacTech Search:
Community Search:

Software Updates via MacUpdate

TeamViewer 9.0.28116 - Establish remote...
TeamViewer gives you remote control of any computer or Mac over the Internet within seconds, or can be used for online meetings. Find out why more than 200 million users trust TeamViewer! Free for... Read more
Viber 4.1.0 - Send messages and make cal...
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,... Read more
Apple iOS 7.1.1 - The latest version of...
The latest version of iOS can be downloaded through iTunes. Apple iOS 7 brings an all-new design and all-new features. Simplicity Simplicity is often equated with minimalism. Yet true simplicity is... Read more
1Password 4.3 - Powerful password manage...
1Password is a password manager that uniquely brings you both security and convenience. It is the only program that provides anti-phishing protection and goes beyond password management by adding Web... Read more
Lens Blur 1.3.0 - True out-of-focus boke...
Let Lens Blur transform your existing photo into true SLR-quality out-of-focus bokeh effect! Everyone needs a gorgeous personalized background for a social profile, blog, Web/UI design, presentation... Read more
VMware Fusion 6.0.3 - Run Windows apps a...
VMware Fusion allows you to create a Virtual Machine on your Mac and run Windows (including Windows 8.1) and Windows software on your Mac. Run your favorite Windows applications alongside Mac... Read more
Tweetbot 1.5.1 - Popular iOS twitter cli...
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
Mac DVDRipper Pro 4.1.7 - Copy, backup,...
Mac DVDRipper Pro is the DVD backup solution that lets you protect your DVDs from scratches, save your batteries by reading your movies from your hard disk, manage your collection with just a few... Read more
PDFpenPro 6.2 - 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. Even correct text and edit graphics! Create... Read more
PDFpen 6.2 - Edit and annotate PDFs with...
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

Gusto Email App Review
Gusto Email App Review By Jennifer Allen on April 23rd, 2014 Our Rating: :: POWERFUL SEARCHINGiPhone App - Designed for the iPhone, compatible with the iPad Focusing on making it easy to browse files and photos attached to your... | Read more »
New Update Adds Two More Cars to Fishlab...
New Update Adds Two More Cars to Fishlabs’ Sports Car Challenge 2 Posted by Rob Rich on April 23rd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
What’s Up with Readdle? – The Verge Exam...
What’s Up with Readdle? | Read more »
Knight Saves Queen Review
Knight Saves Queen Review By Jennifer Allen on April 23rd, 2014 Our Rating: :: PUZZLING MASH UPUniversal App - Designed for iPhone and iPad Mixing up puzzle elements with Chess-based sensibilities is a fun move for this simplistic... | Read more »
Scrap Squad Review
Scrap Squad Review By Jennifer Allen on April 23rd, 2014 Our Rating: :: SIMPLE TRASH COLLECTIONUniversal App - Designed for iPhone and iPad It turns out that dividing up trash can be quite fun in a chaotic kind of way.   | Read more »
Micronytes Director’s Cut Review
Micronytes Director’s Cut Review By Cata Modorcea on April 23rd, 2014 Our Rating: :: DECENTUniversal App - Designed for iPhone and iPad Micronytes isn’t for everyone, but for people who’ve seen the screenshots and haven’t lost... | Read more »
148Apps is Looking for News and Review W...
Looks like it’s that time again. We’ve finished draining the nutritious goo from our victi-I mean we’re looking for more writers! So if you love you some iPods, iPads, and iPhones, and have access to up-to-date iOS hardware (and have a knack for... | Read more »
Wonder Golf Review
Wonder Golf Review By Lee Hamlet on April 23rd, 2014 Our Rating: :: MAD AS A HATTERUniversal App - Designed for iPhone and iPad Help Alice explore a mini-golf version of Wonderland in the quirky Wonder Golf.   | Read more »
Zeebox is Now Beamly TV – Still Offers t...
Zeebox is Now Beamly TV – Still Offers the Same Social Networking TV Fun, Plus a New Look Posted by Rob Rich on April 22nd, 2014 [ permalink ] | Read more »
Bandai Namco Unveils Upcoming Slate of M...
At their recent Global Gamers’ Day event, Bandai Namco was largely focused on their console and PC offerings for the upcoming year. However mobile still had a small presence, with some upcoming titles revealed by the company – though few were in a... | Read more »

Price Scanner via MacPrices.net

iPad Sales “Lull” A Reality Correction Of Unm...
I have lots of time for Jean-Louis Gassée, the former Apple Computer executive (1981 to 1990) who succeeded Steve Jobs as head of Macintosh development when the latter was dismissed in 1985. Mr.... Read more
Apple Makes OS X Betas Available To All – Wit...
Apple’s OS X Beta Seed Program, which lets you install the latest pre-release builds, try it out, and submit your feedback, is now open to anyone who wants to sign on rather than to developers and... Read more
Apple Releases iOS 7.1.1 Update
The latest iOS 7.1.1 update contains improvements, bug fixes and security updates, including: • Further improvements to Touch ID fingerprint recognition • Fixes a bug that could impact keyboard... Read more
Logitech Announces Thinner, Lighter, More Fle...
Logitech has announced an update to its Ultrathin for iPad Air, iPad mini and iPad mini with Retina display, improving the flexibility and design of its award-winning predecessor with an even thinner... Read more
Logitech Introduces Hinge, Big Bang and Turna...
Logitech has announced expansion of its tablet product line with three new cases – the Logitech Hinge, the Logitech Big Bang and the Logitech Turnaround – each for the iPad Air, iPad mini and iPad... Read more
WaterField’s Rough Rider Leather Messenger Ba...
WaterField Designs have announced the new 15-inch size of their popular Rough Rider leather messenger bag, a vintage-looking bag that combines Old West charm and ruggedness with distinctly modern... Read more
New Mac Pro on sale, save $100 on the 4-Core...
J&R has the new 4-Core Mac Pro in stock today and on sale for $2899 including free shipping plus NY sales tax only. Their price is $100 off MSRP, and it’s the lowest price available for this... Read more
Apple refurbished iMacs available for up to $...
The Apple Store has Apple Certified Refurbished 2013 iMacs available for up to $300 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free. - 27″ 3.4GHz iMac – $1699... Read more
Updated iPad Price Trackers
We’ve updated our iPad Price Tracker and our iPad mini Price Tracker with the latest information on prices and availability from Apple and other resellers. Using a mobile device? We’ve also updated... Read more
Everything You Wanted To Know And Probably Mo...
Macworld UK’s Lou Hattersley takes a look inside Apple’s A7 System On Chip (SoC) , noting that its processor module is much more powerful than other smartphone chipsets. He notes that the A7 was a... Read more

Jobs Board

*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
Position Opening at *Apple* - Apple (United...
…customers purchase our products, you're the one who helps them get more out of their new Apple technology. Your day in the Apple Store is filled with a range of Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
*Apple* Inc. Research Data Specialist - Appl...
…of Worldwide Market Research & Intelligence. The team is responsible for conducting Apple branded consumer market research. It is also responsible for analyzing data Read more
*Apple* Automotive Parts Department position...
Apple Automotive is one of the fastest growing dealer…and it shows. Consider making the switch to the Apple Automotive Group today! At Apple Automotive, we Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.