TweetFollow Us on Twitter

Feb 99 Factory Floor

Volume Number: 15 (1999)
Issue Number: 2
Column Tag: From The Factory Floor

Universal Interfaces Today

by Nick Kledzik and Dave Mark, ©1999 by Metrowerks, Inc., all rights reserved.

This month, the Factory Floor visits with Nick Kledzik, Apple's Universal Interface-meister. With our upcoming move to Carbon and MacOS X, the time seems right for an update and Nick was kind enough to give us one.

Nick Kledzik <kledzik@apple.com> has been a software engineer at Apple for over 11 years working on various toolbox managers. In '93 he wrote an internal coding style document called "Building Code" which lead him to his current work of managing the Mac OS API's. Recently he has been working on MRJ (Apple's Java VM), developing JDirect 2.0 which enables java code direct access to the Mac OS toolbox. When not working he's probably pampering his new wife or their cats: Catbert and Hobbes.

Dave: How did the Universal Interfaces get started?

Nick: Back in '93 the PowerMac team was working on the software to enable Macintoshes to use the PowerPC processor instead of the 68k family. The team quickly realized that the existing 68k headers were riddled with 68k-isms and could not be compiled by xlc, the only PowerPC compiler at the time. The first approach was a one shot tool to munge the headers to be compatible with xlc. But, alas, the rest of Apple's software teams continued to use and modify the 68k based headers, and the PowerPC headers were so different that merging and synchronizing changes proved to be an immense time sink.

The solution that evolved was to have a central repository called MasterInterfaces in which all headers were stored. The headers were an augmented form of the 68k headers with their names changed to end in .i instead of .h to ease build rules. A tool called Interfacer was developed which could read the .i files and generate "universal" C headers. The name "universal" was coined because they could be read by both 68k compilers and the PowerPC compiler.

This model proved to be very powerful. The Interfacer was enhanced to generate MixedMode glue for all the System APIs. When we discovered that a #pragma needed to be added to all .h files, all it took was one change to the Interfacer tool and all generated .h files were updated.

In early '94 I headed up a group to fully implement this model. We merged all Apple's public and private headers into MasterInterfaces and updated the Interfacer tool to also emit assembly and Pascal interfaces. The result was the 2.0 Universal Interfaces. Then I started getting serious about being "universal". My goal for the 3.0 Interfaces was that they would "just work" with every compiler on the planet. To do so, every compiler dependent aspect of the headers had to be conditionalized and the core file ConditionalMacros.h had to be able to recognize and auto-configure itself.

Dave: What's the difference between Universal Interfaces and Universal Headers?

Nick: Apple uses the term "interfaces" in the generic sense of the interface between an application and the OS. That's the "I" in API. Metrowerks organized their CodeWarrior CD by naming files for Pascal as "Interfaces" and for C as "Headers". The result was that the term "Universal Headers" was born to describe Apple's Universal Interfaces for C.

Dave: What process do you go through to generate each new batch of Universal Interfaces?

Nick: The overriding question is when to release. For this, I look for either a milestone release from Apple (such as Mac OS 8.1 or 8.5) or a tempting release vehicle such as a CodeWarrior CD release. Once the ship date is locked down, I review the bugs that developers have reported and work with the various engineering teams at Apple to make sure that all changes have been checked into MasterInterfaces. The build part is easy. The Interfacer tool now runs in a batch mode, which means the Interfacer tool is only run once and it emits the C, Pascal, Asm, and Rez files in parallel. The entire build of 750+ files takes under 3 minutes!

Dave: With each new release of the Universal Interfaces, most everyone's code breaks. What is Apple doing to address this problem?

Nick: I review changes in MasterInterfaces and categorize them as to their effect on developers:

  1. Transparent.
  2. Source compatible because of grandfathering of old names or types.
  3. Source compatible if developer changes #includes.
  4. Binary but not source compatible.
  5. Source but not binary compatible.
  6. Neither source nor binary compatible.

Over 95% of the changes are type 1 and are never noticed by developers. For the rest, I work with the engineering teams to make them type 2 by using #defines or typedefs inside of OLDROUTINENAMES so that a developer can make the changes at his leisure. But a few, like moving SysBeep from OSUtils.h to Sound.h, could not be changed to type 1 or 2 because Sound.h already included OSUtils.h and you can't have circular includes.

But, the detection and flagging of these changes is still a manual process and some still slip by me. In the future, Interfacer will become smarter and automatically issue warnings or errors when a source incompatible change is made to a .i file.

Dave: What exactly is Carbon?

Nick: Carbon refers to the subset of Mac OS APIs (functions) in Universal Interfaces that will be supported on Mac OS 8.1 through Mac OS X. In addition, the only clients of Carbon APIs should be application-level code (apps, plugins, shared libraries, etc.) In Mac OS X, drivers will be built using different headers and APIs than applications.

Dave: How will Carbon affect the Universal Interfaces?

Nick: The plan is for a future release of Universal Interfaces to support Carbon development. That is, we will be adding #if statements to the Universal Interfaces so that a developer can assert that he is targeting Carbon (as opposed to System 7 or Mac OS 8.x) and get compile time errors if his code calls any Mac OS function that is not in Carbon. Note, even if he does not assert he is targeting Carbon, he will still get a link time error because you link against different stub libraries when building applications for Carbon.

Dave: Does this mean we are going to have even more Stub Libraries?

Nick: At this time, the plan for Mac OS X is to have one CarbonLib stub library. I'm considering making a similar MacOS8Lib stub library which contains fragments for InterfaceLib, DragLib, SoundLib, etc. This will make it much easier for developers to figure out which stub libraries to use. The problem is there are enough cases where developers want or need a finer level of control (e.g. BlockZero from InterfaceLib vs DriverServicesLib), that I will probably need to ship both the high level conglomerate stub libraries (e.g. MacOS8Lib) and the low level individual stub libraries (e.g. InterfaceLib).

Dave: What changes do you see coming down the pike for programmers who want to call the Mac Toolbox directly from their Java programs?

Nick: Java has and will continue to become faster and easier to use on Macs. But, there is a fundamental impedance mismatch between Java and the Mac OS toolbox. Java is an object oriented language with garbage collection and a theoretically uncrashable runtime. The Mac OS toolbox is none of those things.

Java programmers have a couple of options for easy access to the Mac OS toolbox:

  • Use the standard Java classes such as java.io.File - The implementation of those standard classes on MRJ will "do the right thing" on the Mac OS, such as setting file types and creators via Internet Config.
  • Use packages written specifically for java clients who want to access toolbox functionality such as QuickTime for Java or MRJToolkit.
  • MRJ 2.1 contains a feature called JDirect which allows Java code to easily call into Mac OS shared libraries and the MRJ 2.1 SDK contains java bindings generated by the Interfacer tool. The combination allows developers to call any Mac OS API directly from Java. But, the developer still has to write Java code to handle things like Pascal strings, memory allocation and deallocation, etc.

As time goes on, Apple and third parties will continue to write more Java packages which make it easier to use Mac OS specific functionality from Java. It is an open question whether anyone will write a Mac OS only framework in Java (a la MacApp).

Dave: In a similar vein, what changes do you see for C++ and Pascal programmers?

Nick: The Mac OS toolbox has standardized on procedural ABIs (application binary interfaces). This has enabled applications to be written in most any language. It is unlikely that any non-procedural features (e.g. C++ objects) will be added to the Mac OS APIs. These sorts of things should be layered onto the Universal Interfaces as is done with PowerPlant.

There are a few C++ things which do make sense in the Universal Interfaces such as inlined functions instead of parameterized macros and the use of name spaces. These are both on my to-do list.

Pascal Interfaces will continue to be generated from MasterInterfaces. But, because Pascal has not been standardized the way C has, developers using different Pascal compilers have needed to modify Apple's Universal Interfaces for Pascal to work with their compiler. Since Pascal does not have a preprocessor, there really is no way to make truly universal interfaces.

I think the long term solution for Pascal and other language support (e.g. Lisp, Fortran, Basic, etc.) is to open up the Interfacer tool. A current project of mine is researching how to deliver a "Universal Interfaces Kit" which contains the data and a framework for developers to generate their own interfaces.

 
AAPL
$105.22
Apple Inc.
+0.39
MSFT
$46.13
Microsoft Corpora
+1.11
GOOG
$539.78
Google Inc.
-4.20

MacTech Search:
Community Search:

Software Updates via MacUpdate

OS X Server 4.0 - For OS X 10.10 Yosemit...
Designed for OS X and iOS devices, OS X Server makes it easy to share files, schedule meetings, synchronize contacts, develop software, host your own website, publish wikis, configure Mac, iPhone,... Read more
TotalFinder 1.6.12 - Adds tabs, hotkeys,...
TotalFinder is a universally acclaimed navigational companion for your Mac. Enhance your Mac's Finder with features so smart and convenient, you won't believe you ever lived without them. Tab-based... Read more
BusyCal 2.6.3 - 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. BusyCal's unique... Read more
calibre 2.7 - Complete e-library managem...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital... Read more
Skitch 2.7.3 - Take screenshots, annotat...
With Skitch, taking, annotating, and sharing screenshots or images is as fun as it is simple.Communicate and collaborate with images using Skitch and its intuitive, engaging drawing and annotating... Read more
Delicious Library 3.3.2 - Import, browse...
Delicious Library allows you to import, browse, and share all your books, movies, music, and video games with Delicious Library. Run your very own library from your home or office using our... Read more
Art Text 2.4.8 - Create high quality hea...
Art Text is an OS X application for creating high quality textual graphics, headings, logos, icons, Web site elements, and buttons. Thanks to multi-layer support, creating complex graphics is no... Read more
Live Interior 3D Pro 2.9.6 - Powerful an...
Live Interior 3D Pro is a powerful yet very intuitive interior designing application. View Video Tutorials It has every feature of Live Interior 3D Standard, plus some exclusive ones: Create multi... Read more
The Hit List 1.1.7 - Advanced reminder a...
The Hit List manages the daily chaos of your modern life. It's easy to learn - it's as easy as making lists. And it's powerful enough to let you plan, then forget, then act when the time is right.... Read more
jAlbum Pro 12.2.4 - Organize your digita...
jAlbum Pro has all the features you love in jAlbum, but comes with a commercial license. With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code!... Read more

Latest Forum Discussions

See All

Rami Ismail Opens Up distribute​() for D...
Rami Ismail Opens Up distribute​() for Developers Posted by Jessica Fisher on October 24th, 2014 [ permalink ] Rami Ismail, Chief Executive of Business and Development at indie game studio | Read more »
Great Hitman GO Goes on Sale and Gets Ne...
Great Hitman GO Goes on Sale and Gets New Update – Say That Three Times Fast Posted by Jessica Fisher on October 24th, 2014 [ permalink ] | Read more »
Rival Stars Basketball Review
Rival Stars Basketball Review By Jennifer Allen on October 24th, 2014 Our Rating: :: RESTRICTIVE BUT FUNUniversal App - Designed for iPhone and iPad Rival Stars Basketball is a fun mixture of basketball and card collecting but its... | Read more »
Rubicon Development Makes Over a Dozen o...
Rubicon Development Makes Over a Dozen of Their Games Free For This Weekend Only Posted by Jessica Fisher on October 24th, 2014 [ permalink ] | Read more »
I Am Dolphin Review
I Am Dolphin Review By Jennifer Allen on October 24th, 2014 Our Rating: :: NEARLY FIN-TASTICUniversal App - Designed for iPhone and iPad Swim around and eat nearly everything that moves in I Am Dolphin, a fun Ecco-ish kind of game... | Read more »
nPlayer looks to be the ultimate choice...
Developed by Newin Inc, nPlayer may seem like your standard video player – but is aiming to be the best in its field by providing high quality video play performance and support for a huge number of video formats and codecs. User reviews include... | Read more »
Fighting Fantasy: Caverns of the Snow Wi...
Fighting Fantasy: Caverns of the Snow Witch Review By Jennifer Allen on October 24th, 2014 Our Rating: :: CLASSY STORYTELLINGUniversal App - Designed for iPhone and iPad Fighting Fantasy: Caverns of the Snow Witch is a sterling... | Read more »
A Few Days Left (Games)
A Few Days Left 1.01 Device: iOS Universal Category: Games Price: $3.99, Version: 1.01 (iTunes) Description: Screenshots are in compliance to App Store's 4+ age rating! Please see App Preview for real game play! **Important: Make... | Read more »
Toca Boo (Education)
Toca Boo 1.0.2 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0.2 (iTunes) Description: BOO! Did I scare you!? My name is Bonnie and my family loves to spook! Do you want to scare them back? Follow me and I'll... | Read more »
Intuon (Games)
Intuon 1.1 Device: iOS Universal Category: Games Price: $.99, Version: 1.1 (iTunes) Description: Join the battle with your intuition in a new hardcore game Intuon! How well do you trust your intuition? Can you find a needle in a... | Read more »

Price Scanner via MacPrices.net

Weekend sale: 13-inch 128GB MacBook Air for $...
Best Buy has the 2014 13-inch 1.4GHz 128GB MacBook Air on sale for $849.99, or $150 off MSRP, on their online store. Choose free home shipping or free local store pickup (if available). Price valid... Read more
Nimbus Note Cross=Platform Notes Utility
Nimbus Note will make sure you never forget or lose your valuable data again. Create and edit notes, save web pages, screenshots and any other type of data – and share it all with your friends and... Read more
NewerTech’s Snuglet Makes MagSafe 2 Power Con...
NewerTech has introduced the Snuglet, a precision-manufactured ring designed to sit inside your MagSafe 2 connector port, providing a more snug fit to prevent your power cable from unintentional... Read more
Apple Planning To Sacrifice Gross Margins To...
Digitimes Research’s Jim Hsiao says its analysts believe Apple is planning to sacrifice its gross margins to save its tablet business, which has recently fallen into decline. They project that Apple’... Read more
Who’s On Now? – First Instant-Connect Search...
It’s nighttime and your car has broken down on the side of the highway. You need a tow truck right away, so you open an app on your iPhone, search for the closest tow truck and send an instant... Read more
13-inch 2.5GHz MacBook Pro on sale for $949,...
Best Buy has the 13″ 2.5GHz MacBook Pro available for $949.99 on their online store. Choose free shipping or free instant local store pickup (if available). Their price is $150 off MSRP. Price is... Read more
Save up to $125 on Retina MacBook Pros
B&H Photo has the new 2014 13″ and 15″ Retina MacBook Pros on sale for up to $125 off MSRP. Shipping is free, and B&H charges NY sales tax only. They’ll also include free copies of Parallels... Read more
Apple refurbished Time Capsules available sta...
The Apple Store has certified refurbished Time Capsules available for up to $60 off MSRP. Apple’s one-year warranty is included with each Time Capsule, and shipping is free: - 2TB Time Capsule: $255... Read more
Textilus New Word, Notes and PDF Processor fo...
Textilus is new word-crunching, notes, and PDF processor designed exclusively for the iPad. I haven’t had time to thoroughly check it out yet, but it looks great and early reviews are positive.... Read more
WD My Passport Pro Bus-Powered Thunderbolt RA...
WD’s My Passport Pro RAID solution is powered by an integrated Thunderbolt cable for true portability and speeds as high as 233 MB/s. HighlightsOverviewSpecifications Transfer, Back Up And Edit In... Read more

Jobs Board

*Apple* Solutions Consultant - Apple Inc. (U...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include: * Promoting Apple products and solutions Read more
Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, 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
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.