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.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Vitamin-R 2.45 - Personal productivity t...
Vitamin-R creates the optimal conditions for your brain to work at its best by structuring your work into short bursts of distraction-free, highly focused activity alternating with opportunities for... Read more
BetterTouchTool 2.08 - Customize Multi-T...
BetterTouchTool adds many new, fully customizable gestures to the Magic Mouse, Multi-Touch MacBook trackpad, and Magic Trackpad. These gestures are customizable: Magic Mouse: Pinch in / out (zoom... Read more
NeoOffice 2015.12 - Mac-tailored, OpenOf...
NeoOffice is a complete office suite for OS X. With NeoOffice, users can view, edit, and save OpenOffice documents, PDF files, and most Microsoft Word, Excel, and PowerPoint documents. NeoOffice 3.x... Read more
Together 3.7.5 - Store and organize all...
Together helps you organize your Mac, giving you the ability to store, edit and preview your files in a single clean, uncluttered interface. Features Smart storage. With simple drag-and-drop... Read more
Cocktail 10.3 - General maintenance and...
Cocktail is a general purpose utility for macOS that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
Stylizer 6.17.228.1062 - Real-time CSS e...
Stylizer helps you style websites in a fraction of the time. Features Real-time CSS - Immediate feedback saves countless hours. Say goodbye to the reload button! In Stylizer, your changes are... Read more
Simon 4.2.2 - $99.00
Simon monitors websites and alerts you of crashes and changes. Select pages to monitor, choose your alert options, and customize your settings. Simon does the rest. Keep a watchful eye on your... Read more
iFFmpeg 6.2.6 - Convert multimedia files...
iFFmpeg is a comprehensive media tool to convert movie, audio and media files between formats. The FFmpeg command line instructions can be very hard to master/understand, so iFFmpeg does all the hard... Read more
Dropbox 20.4.19 - Cloud backup and synch...
Dropbox is an application that creates a special Finder folder that automatically syncs online and between your computers. It allows you to both backup files and keep them up-to-date between systems... Read more
DiskCatalogMaker 6.6 - Catalog your disk...
DiskCatalogMaker is a simple disk management tool which catalogs disks. Simple, light-weight, and fast Finder-like intuitive look and feel Super-fast search algorithm Can compress catalog data for... Read more

Tavern Guardians Guide: How to survive e...
Tavern Guardians is a match-three game that brings some much-needed innovation to what is a tired genre in mobile gaming. Players match objects to attack enemies while healing themselves, forcing players to rethink their approach to the typical... | Read more »
Inkle's next big project is Heaven...
Inkle's latest project could be its most exciting yet, following the widespread success of their past two games, Sorcery! and 80 Days. Their latest title, Heaven's Vault, which was announced at GDC this week, steps away from the gamebook genre,... | Read more »
Last week on Pocket Gamer
If you’re wondering what’s going on in the wider world of portable gaming, our sister site PocketGamer has you covered. Each week we like to check in on the PG team and see what they’ve been preoccupied with. From the latest on the Nintendo Switch... | Read more »
Mudd Masher arrives this week
Atooi Games, the minds behind Totes the Goat and Mutant Mudds, have a new game in the works -- Mudd Masher. The game, a hybrid of the independent studio's first two titles, is expected to launch this week on March 2. [Read more] | Read more »
The best sales on the App Store this wee...
The App Store has quite an exciting lineup of discount games this week that range across a variety of genres. It's a great opportunity to catch up on some of the premium games you may have been holding off on -- and some you can even grab for free... | Read more »
The best new games we played this week
Ah, here we are again at the close of another busy week. Don't rest too easy, though. We had a lot of great new releases in mobile games this week, and now you're going to have to spend all weekend playing them. That shouldn't be too much of a... | Read more »
Rollercoaster Tycoon Touch Guide: How to...
| Read more »
Rabbids Crazy Rush Guide: How to unlock...
The Rabbids are back in a new endless running adventure, Rabbids Crazy Rush. It's more ridiculous cartoon craziness as you help the little furballs gather enough fuel (soda) to get to the moon. Sure, it's a silly idea, but everyone has dreams --... | Read more »
Tavern Guardians (Games)
Tavern Guardians 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Tavern Guardians is a Hack-and-Slash action game played in the style of a match-three. You can experience high pace action... | Read more »
Slay your way to glory in idle RPG Endle...
It’s a golden age for idle games on the mobile market, and those addictive little clickers have a new best friend. South Korean developer Ekkorr released Endless Frontier last year, and players have been idling away the hours in the company of its... | Read more »

Price Scanner via MacPrices.net

Back in stock: Apple refurbished 13-inch Reti...
Apple has Certified Refurbished 2015 13″ Retina MacBook Pros available for up to $360 off original MSRP, starting at $1099. An Apple one-year warranty is included with each model, and shipping is... Read more
“Sealed” Apple Notebooks Demand More Battery...
In most aspects, my two MacBook Airs (one a mid-2013 revision and the other the current early-2015 refresh spec.) are the best computers I’ve owned over the past 25 years. The only major... Read more
Intro to Real Life Now Available On The iBook...
Just in time for Lent, Washington based Duccats has released Intro to Real Life, a new iBook with an accessible photo-based introduction to the Christian worldview. Intro to Real Life fills a... Read more
13-inch 2.5GHz MacBook Pro (Apple refurbished...
Apple has Certified Refurbished 13″ 2.5GHz MacBook Pros (MD101LL/A) available for $829, or $270 off original MSRP. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.5GHz MacBook... Read more
Save $150-$180 with Apple refurbished 13-inch...
Apple has Certified Refurbished 2016 13″ MacBook Airs available starting at $849. An Apple one-year warranty is included with each MacBook, and shipping is free: - 13″ 1.6GHz/8GB/128GB MacBook Air: $... Read more
Apple’s Education discount saves up to $300 o...
Purchase a new Mac or iPad using Apple’s Education Store and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free: -... Read more
SanDisk Introduces 256GB Storage Expansion Fo...
Western Digital Corporation at Mobile World Congress in Barcelona, Spain on Tuesday announced that it has increased the capacity of its line of iOS mobile flash drives with the introduction of its... Read more
FINSiX DART World’s Smallest and Lightest Lap...
Up to 4x smaller and lighter than today’s typical 65W laptop chargers, and with a built-in Smallest and Lightest Laptop Charger, DART allows you to charge all your devices from a single outlet.... Read more
New iPads May Not Arrive Until May or June –...
Digitimes’ Siu Han and Steve Shen say their sources in the iPad upstream supply chain are anticipating disappointing calendar first-quarter 2017 sales. The same sources at upstream suppliers had... Read more
Olay Unveils Skin Advisor App To Help Women B...
Olay celebrated its Mobile World Congress debut with the global launch of Olay Skin Advisor, a new app designed to help women better understand their skin and find the products best-suited to their... Read more

Jobs Board

*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Solutions Consultant - Apple (United...
# Apple Solutions Consultant Job Number: 55676865 Los Angeles, California, United States Posted: Feb. 22, 2017 Weekly Hours: 40.00 **Job Summary** As an Apple Read more
Programmer/Editor *Apple* Music Dance - App...
# Programmer/Editor Apple Music Dance Job Number: 55565967 Culver City, California, United States Posted: Feb. 23, 2017 Weekly Hours: **Job Summary** Apple Music Read more
Digital Marketing Specialist - *Apple* iClo...
# Digital Marketing Specialist - Apple iCloud Job Number: 54729233 Culver City, California, United States Posted: Feb. 22, 2017 Weekly Hours: 40.00 **Job Summary** Read more
Marketing Specialist, iTunes & *Apple*...
# Marketing Specialist, iTunes & Apple Music Job Number: 55704205 Culver City, California, United States Posted: Feb. 23, 2017 Weekly Hours: 40.00 **Job Summary** Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.