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
$99.76
Apple Inc.
+2.09
MSFT
$44.08
Microsoft Corpora
+0.45
GOOG
$520.84
Google Inc.
+9.67

MacTech Search:
Community Search:

Software Updates via MacUpdate

TechTool Pro 7.0.5 - Hard drive and syst...
TechTool Pro is now 7, and this is the most advanced version of the acclaimed Macintosh troubleshooting utility created in its 20-year history. Micromat has redeveloped TechTool Pro 7 to be fully 64... Read more
PDFKey Pro 4.0.2 - Edit and print passwo...
PDFKey Pro can unlock PDF documents protected for printing and copying when you've forgotten your password. It can now also protect your PDF files with a password to prevent unauthorized access and/... Read more
Yasu 2.9.1 - System maintenance app; per...
Yasu was originally created with System Administrators who service large groups of workstations in mind, Yasu (Yet Another System Utility) was made to do a specific group of maintenance tasks... Read more
Hazel 3.3 - Create rules for organizing...
Hazel is your personal housekeeper, organizing and cleaning folders based on rules you define. Hazel can also manage your trash and uninstall your applications. Organize your files using a... Read more
Autopano Giga 3.7 - Stitch multiple imag...
Autopano Giga allows you to stitch 2, 20, or 2,000 images. Version 3.0 integrates impressive new features that will definitely make you adopt Autopano Pro or Autopano Giga: Choose between 9... Read more
MenuMeters 1.8 - CPU, memory, disk, and...
MenuMeters is a set of CPU, memory, disk, and network monitoring tools for Mac OS X. Although there are numerous other programs which do the same thing, none had quite the feature set I was looking... Read more
Coda 2.5 - One-window Web development su...
Coda is a powerful Web editor that puts everything in one place. An editor. Terminal. CSS. Files. With Coda 2, we went beyond expectations. With loads of new, much-requested features, a few... Read more
Arq 4.6.1 - Online backup to Google Driv...
Arq is super-easy online backup for the Mac. Back up to your own Google Drive storage (15GB free storage), your own Amazon Glacier ($.01/GB per month storage) or S3, or any SFTP server. Arq backs up... Read more
Airfoil 4.8.10 - Send audio from any app...
Airfoil allows you to send any audio to AirPort Express units, Apple TVs, and even other Macs and PCs, all in sync! It's your audio - everywhere. With Airfoil you can take audio from any... Read more
Apple iMovie 10.0.6 - Edit personal vide...
With an all-new design, Apple iMovie lets you enjoy your videos like never before. Browse your clips more easily, instantly share your favorite moments, and create beautiful HD movies and Hollywood-... Read more

Latest Forum Discussions

See All

This Week at 148Apps: October 13-17, 201...
Expert App Reviewers   So little time and so very many apps. What’s a poor iPhone/iPad lover to do? Fortunately, 148Apps is here to give you the rundown on the latest and greatest releases. And we even have a tremendous back catalog of reviews; just... | Read more »
Angry Birds Transformers Review
Angry Birds Transformers Review By Jennifer Allen on October 20th, 2014 Our Rating: :: TRANSFORMED BIRDSUniversal App - Designed for iPhone and iPad Transformed in a way you wouldn’t expect, Angry Birds Transformers is a quite... | Read more »
GAMEVIL Announces the Upcoming Launch of...
GAMEVIL Announces the Upcoming Launch of Mark of the Dragon Posted by Jessica Fisher on October 20th, 2014 [ permalink ] Mark of the Dragon, by GAMEVIL, put | Read more »
Interview With the Angry Birds Transform...
Angry Birds Transformers recently transformed and rolled out worldwide. This run-and-gun title is a hit with young Transformers fans, but the ample references to classic Transformers fandom has also earned it a place in the hearts of long-time... | Read more »
Find Free Food on Campus with Ypay
Find Free Food on Campus with Ypay Posted by Jessica Fisher on October 20th, 2014 [ permalink ] iPhone App - Designed for the iPhone, compatible with the iPad | Read more »
Strung Along Review
Strung Along Review By Jordan Minor on October 20th, 2014 Our Rating: :: GOT NO STRINGSUniversal App - Designed for iPhone and iPad A cool gimmick and a great art style keep Strung Along from completely falling apart.   | Read more »
P2P file transferring app Send Anywhere...
File sharing services like Dropbox have security issues. Email attachments can be problematic when it comes to sharing large files. USB dongles don’t fit into your phone. Send Anywhere, a peer-to-peer file transferring application, solves all of... | Read more »
Zero Age Review
Zero Age Review By Jordan Minor on October 20th, 2014 Our Rating: :: MORE THAN ZEROiPad Only App - Designed for the iPad With its mind-bending puzzles and spellbinding visuals, Zero Age has it all.   | Read more »
Hay Ewe Review
Hay Ewe Review By Campbell Bird on October 20th, 2014 Our Rating: :: SAVE YOUR SHEEPLEUniversal App - Designed for iPhone and iPad Pave the way for your flock in this line drawing puzzle game from the creators of Worms.   | Read more »
My Very Hungry Caterpillar (Education)
My Very Hungry Caterpillar 1.0.0 Device: iOS Universal Category: Education Price: $3.99, Version: 1.0.0 (iTunes) Description: Care for your very own Very Hungry Caterpillar! My Very Hungry Caterpillar will captivate you as he crawls... | Read more »

Price Scanner via MacPrices.net

2013 15-inch 2.0GHz Retina MacBook Pro availa...
B&H Photo has leftover previous-generation 15″ 2.0GHz Retina MacBook Pros now available for $1599 including free shipping plus NY sales tax only. Their price is $400 off original MSRP. B&H... Read more
Updated iPad Prices
We’ve updated our iPad Air Price Tracker and our iPad mini Price Tracker with the latest information on prices and availability from Apple and other resellers, including the new iPad Air 2 and the... Read more
Apple Pay Available to Millions of Visa Cardh...
Visa Inc. brings secure, convenient payments to iPad Air 2 and iPad mini 3as well as iPhone 6 and 6 Plus. Starting October 20th, eligible Visa cardholders in the U.S. will be able to use Apple Pay,... Read more
Textkraft Pocket – the missing TextEdit for i...
infovole GmbH has announced the release and immediate availability of Textkraft Pocket 1.0, a professional text editor and note taking app for Apple’s iPhone. In March 2014 rumors were all about... Read more
C Spire to offer iPad Air 2 and iPad mini 3,...
C Spire on Friday announced that it will offer iPad Air 2 and iPad mini 3, both with Wi-Fi + Cellular, on its 4G+ LTE network in the coming weeks. C Spire will offer the new iPads with a range of... Read more
Belkin Announces Full Line of Keyboards and C...
Belkin International has unveiled a new lineup of keyboard cases and accessories for Apple’s newest iPads, featuring three QODE keyboards and a collection of thin, lightweight folios for both the... Read more
Verizon offers new iPad Air 2 preorders for $...
Verizon Wireless is accepting preorders for the new iPad Air 2, cellular models, for $100 off MSRP with a 2-year service agreement: - 16GB iPad Air 2 WiFi + Cellular: $529.99 - 64GB iPad Air 2 WiFi... Read more
Price drops on refurbished Mac minis, now ava...
The Apple Store has dropped prices on Apple Certified Refurbished previous-generation Mac minis, with models now available starting at $419. Apple’s one-year warranty is included with each mini, and... Read more
Apple refurbished 2014 MacBook Airs available...
The Apple Store has Apple Certified Refurbished 2014 MacBook Airs available for up to $180 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is free.... Read more
Refurbished 2013 MacBook Pros available for u...
The Apple Store has Apple Certified Refurbished 13″ and 15″ MacBook Pros available starting at $929. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.5GHz MacBook Pros (4GB RAM/... Read more

Jobs Board

*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
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
Position Opening at *Apple* - Apple (United...
**Job Summary** At the Apple Store, you connect business professionals and entrepreneurs with the tools they need in order to put Apple solutions to work in their Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** The Apple Store is a retail environment like no other - uniquely focused on delivering amazing customer experiences. As an Expert, you introduce people Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** As businesses discover the power of Apple computers and mobile devices, it's your job - as a Solutions Engineer - to show them how to introduce these Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.