TweetFollow Us on Twitter

Learning to Love SOM
Volume Number:11
Issue Number:1
Column Tag:Foundation Technology

Learning To Love SOM

Choosing it for OpenDoc was a no-brainer

By Jens Peter Alfke, Apple Computer, Inc.

The System Object Model (SOM) provides the object-oriented substrate used by OpenDoc and by future versions of the Macintosh Toolbox. SOM is fairly complex, relatively new on the Mac, and competes against other proprietary object models. It’s not surprising, then, that there is some degree of apprehension and misinformation surrounding it. In this article, I will give you the straight scoop on SOM.

Frankly, my own initial feelings toward SOM were not warm and fuzzy. After we on the OpenDoc team decided to make the move to SOM, and I began reading about it and thinking about the task of converting our existing code base, I was heard to ask Kurt Piersol: “We’re all going to die, aren’t we?” Fortunately, I was wrong; and since then I’ve come to like and respect SOM.

Why Is SOM Necessary?

Object-based shared libraries are a holy grail of software engineering, since they turn code into black-box components that can be plugged together by programmers. Unfortunately, existing object models have been either too slow and too hard to use from existing code (e.g. Smalltalk), or insufficiently robust (e.g. C++.)

Fragile Base Classes

What do I mean by “insufficiently robust”? The technical term is fragile base-classes, and what it means is that changes to a base class - such as adding methods or instance variables - often break code that uses the base class, or makes subclasses of it, until that client code is recompiled.

In other words, if I update my JensTools C++ class library from version 1.0 to 1.1, and users install the new version, all their apps that use it may crash until they get new releases from the developers. Needless to say, this has impeded the use of object-based shared libraries.

There are two ways around this. The first is to abandon key features of object-oriented programming like inheritance and polymorphism. This is what Microsoft’s Component Object Model (COM) does. What you’re left with is a system of procedural dispatch tables that I find quite reminiscent of the Component Manager. I’ve used the Component Manager extensively as part of developing AppleScript, and let me say that it is not my favorite shared library solution. (For a much more detailed look at how SOM and COM differ, read “SOM vs. COM” in the documentation folder on the CD.)

The better solution is to attack the problem head on and fix it, which is what researchers at IBM did in producing SOM. I won’t go into the gory details here, but by abstracting the way object instantiation and method dispatch work, they were able to produce an object model that is extremely robust and still efficient and fully object-oriented.

In other words, by basing my JensTools library on SOM (though it’s still implemented in C++) I am able to add new methods and/or change its internal implementation while retaining full binary compatibility: when users install the new version, their existing apps continue to work perfectly, while new clients can take advantage of the new features.

Language and Compiler Neutrality

A frequently-mentioned advantage of SOM is that it can be used with any programming language, once the appropriate interfaces and glue code are written. This is because the SOM kernel isn’t based on any single object model, and has robust enough support for almost any language (for instance, it supports metaclasses and name-based dispatching, features found in Smalltalk but not in C++.) C and C++ support currently exist, with Smalltalk in the works.

Language neutrality is also sometimes disparaged; some see it as nothing more than unnecessary support for exotic languages that no one uses. Setting aside the fact that many large businesses are using Smalltalk, and that it would be damn cool to be able to write OpenDoc parts in Dylan, what these critics don’t realize or admit is that different C++ compilers might as well be different languages when it comes to their runtime object model. Due to differences in vtable layout and parameter passing, objects created by one C++ compiler generally cannot be used by client code compiled by a different C++ compiler. On the Mac, cfront, Apple’s new Mr.C compiler, Symantec C++ and Metrowerks’ C++ are all mutually incompatible.

This incompatibility causes headaches even with COM. A frequent trick used by COM programs is to use a C++ vtable as a COM method table. By strange coincidence, this works just fine with the vtables laid out by the Microsoft C++ compiler. But it doesn’t work with most other C++ compilers, and users of those compilers are forced to lay out the method tables by hand, which turns out to be a lot more difficult than creating a SOM class (in fact, it’s a lot like the tables SOM builds internally and thankfully hides from you.)

Cross-Platform Support

Implementations of SOM currently exist for OS/2, Unix, Windows, and now the Macintosh (both 68k and native PowerPC, included on the OpenDoc CD.) Future targets include Netware, IBM’s Workplace, MVS and OS/400. IBM plans to license SOM to Component Integration Labs, so it will be available for other vendors to license.

Using SOM With C++

This adds up to a pretty compelling case for using SOM. There’s nothing else available that supports real object-oriented programming, with strong binary compatibility, language and compiler independence, that runs on all major operating systems. Choosing it for OpenDoc was a no-brainer once we’d analyzed the alternatives.

Unfortunately you do give up some things when you use SOM from C++. SOM is not tied to the C++ object model, and it doesn’t support some fancier C++ features like templates and operator overloading (although it does do things C++ doesn’t, like metaclasses and name-based dispatching.) SOM classes aren’t the same as C++ classes; this isn’t apparent on the client side since you call methods of a SOM object exactly as you would a C++ object, but a SOM class’ methods are implemented as procedural functions, which adds a certain amount of “syntactic vinegar” to your implementation (as my colleague Richard Rodseth puts it.)

Many of these drawbacks will be alleviated by direct-to-SOM C++ compilers. These are compilers with a native understanding of the SOM object model, which make creating a SOM class as simple as inheriting from SOMObject. Direct-to-SOM compilers are already available for OS/2 and Windows, and may be on the Mac soon.

Until then, there are tricks you can use if you want to do your work closer to normal C++. One that works well, and is used in the sample OpenDoc leaf part class that comes with PartMaker, is to create a normal C++ class with basically the same API as the SOM class you want to implement. Then the SOM class’ implementation simply instantiates a matching object of the C++ class, and each SOM method calls the corresponding C++ method. This incurs a little bit of extra overhead, but eases the transition to SOM for someone familiar with C++.

Cool Features

SOM supports features you don’t ordinarily get with C++. For instance, you can determine the class of an arbitrary SOM object at runtime, or check whether an object descends from a particular class or implements a particular method. You can examine all the methods defined by a particular class and send an arbitrary message to an object given a string representing the method name. You can even add new methods to a class at runtime. All this is possible because SOM supports metaclasses, a concept originating in Smalltalk which means that SOM classes are real objects.

Building A SOM Class

The full process of implementing a SOM class consists of:

• Write an IDL file: a SOM header that declares your class’ interface. The class will inherit from an existing SOM class (such as SOMObject, or ODPart for an OpenDoc part handler). In the interface you add any extra methods and instance variables that your part objects will need.

IDL stands for Interface Definition Language, a simple syntax for defining classes. It’s part of the industry-standard CORBA architecture. Fortunately, IDL looks very much like a C++ class definition, with a few extensions.

• Crank your IDL file through the SOM compiler. This translates your part’s definition from the abstract IDL syntax into a C or C++ API, plus the appropriate magic glue for the SOM runtime. The output is several binding files that you use to build your part with C or C++.

• Fill out the implementation. One of the binding files generated is a .c or .cpp file that contains a blank C or C++ implementation of your part: the method functions are all there but their bodies are empty. You fill in the bodies with the actual code for each method.

• Compile and link the implementation files. The implementation binding file and any other source files you create are linked against the SOM library, and the libraries of any other SOM classes you use or inherit from, to produce a shared library that implements your class. You can use any compiler that knows how to build CFM shared libraries, such as scpp or CodeWarrior PPC.

• Iterate. If you fix bugs or make other changes that just modify existing class methods, or non-class code, all you need to do is recompile and relink. If you need to change the class structure by adding methods or instance variables, you’ll need to run the SOM compiler again. The (blank) new methods will be appended to your implementation file without disturbing the existing C/C++ code.

Networked Objects

SOM has an extension called DSOM that supports distributed objects. It allows SOM objects on different machines on a network (or in separate address spaces on one machine) to talk to each other as though they were all running in the same process. DSOM is pretty transparent to your code; you just have to avoid pitfalls like trying to send a remote object a raw pointer to data.

DSOM already runs on OS/2 and will be ported to the Mac OS; we plan to support it in the second release of OpenDoc to allow distributed parts, documents and other services.

On a broader scale yet, DSOM is an implementation of CORBA, an industry standard for distributed objects. This means that DSOM clients can interact with non-SOM distributed applications from vendors like DEC and H/P, running on workstations or mainframes. This gives SOM-based systems like OpenDoc a well defined way to connect to large corporate databases, which may or may not excite you but makes IS managers sit up and drool.

Conclusion

SOM is one of those things where you have to look at the big picture. Yes, it’s a bit of a pain at the micro-level of individual lines of code. But alternatives like COM, which may seem simpler at first, turn out to be more complicated when used with some compilers, and too limited to support true object-oriented programming. And SOM becomes extremely cool at the larger scale of reusable and robust shared class libraries, and positively mind-bending with its prospects of distributed objects and Net-spanning applications.

 
AAPL
$99.02
Apple Inc.
+1.35
MSFT
$43.97
Microsoft Corpora
-0.53
GOOG
$590.60
Google Inc.
+1.58

MacTech Search:
Community Search:

Software Updates via MacUpdate

OS X Yosemite Wallpaper 1.0 - Desktop im...
OS X Yosemite Wallpaper is the gorgeous new background image for Apple's upcoming OS X 10.10 Yosemite. This wallpaper is available for all screen resolutions with a source file that measures 5,418... Read more
Acorn 4.4 - Bitmap image editor. (Demo)
Acorn is a new image editor built with one goal in mind - simplicity. Fast, easy, and fluid, Acorn provides the options you'll need without any overhead. Acorn feels right, and won't drain your bank... Read more
Bartender 1.2.20 - Organize your menu ba...
Bartender lets you organize your menu bar apps. Features: Lets you tidy your menu bar apps how you want. See your menu bar apps when you want. Hide the apps you need to run, but do not need to... Read more
TotalFinder 1.6.2 - 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
Vienna 3.0.0 RC 2 :be5265e: - RSS and At...
Vienna is a freeware and Open-Source RSS/Atom newsreader with article storage and management via a SQLite database, written in Objective-C and Cocoa, for the OS X operating system. It provides... Read more
VLC Media Player 2.1.5 - Popular multime...
VLC Media Player is a highly portable multimedia player for various audio and video formats (MPEG-1, MPEG-2, MPEG-4, DivX, MP3, OGG, ...) as well as DVDs, VCDs, and various streaming protocols. It... Read more
Default Folder X 4.6.7 - Enhances Open a...
Default Folder X attaches a toolbar to the right side of the Open and Save dialogs in any OS X-native application. The toolbar gives you fast access to various folders and commands. You just click... Read more
TinkerTool 5.3 - Expanded preference set...
TinkerTool is an application that gives you access to additional preference settings Apple has built into Mac OS X. This allows to activate hidden features in the operating system and in some of the... Read more
Audio Hijack Pro 2.11.0 - Record and enh...
Audio Hijack Pro drastically changes the way you use audio on your computer, giving you the freedom to listen to audio when you want and how you want. Record and enhance any audio with Audio Hijack... Read more
Intermission 1.1.1 - Pause and rewind li...
Intermission allows you to pause and rewind live audio from any application on your Mac. Intermission will buffer up to 3 hours of audio, allowing users to skip through any assortment of audio... Read more

Latest Forum Discussions

See All

Traps n’ Gemstones Review
Traps n’ Gemstones Review By Campbell Bird on July 28th, 2014 Our Rating: :: CASTLEVANIA JONESUniversal App - Designed for iPhone and iPad Fight mummies, dig tunnels, and ride a runaway minecart to discover ancient secrets in this... | Read more »
The Phantom PI Mission Apparition Review
The Phantom PI Mission Apparition Review By Jordan Minor on July 28th, 2014 Our Rating: :: GHOSTS BUSTEDUniversal App - Designed for iPhone and iPad The Phantom PI is an exceedingly clever and well-crafted adventure game.   | Read more »
More Stubies Are Coming Your Way in a Ne...
More Stubies Are Coming Your Way in a New Update Posted by Jessica Fisher on July 28th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
The Great Prank War Review
The Great Prank War Review By Nadia Oxford on July 28th, 2014 Our Rating: :: PRANKING IS SERIOUS BUSINESSUniversal App - Designed for iPhone and iPad Though short, The Great Prank War offers an interesting and fun mix of action and... | Read more »
Marvel Contest of Champions Announced at...
Marvel Contest of Champions Announced at Comic-Con Posted by Jennifer Allen on July 28th, 2014 [ permalink ] Announced over the weekend at San Diego Comic-Con was the fairly exciting looking Marvel Contest of Champions. | Read more »
Teenage Mutant Ninja Turtles Review
Teenage Mutant Ninja Turtles Review By Jennifer Allen on July 28th, 2014 Our Rating: :: DULL SWIPINGUniversal App - Designed for iPhone and iPad The pizza power is weak when it comes to this Teenage Mutant Ninja Turtles game.   | Read more »
Exploration Focused Puzzle Game Beatbudd...
Exploration Focused Puzzle Game Beatbuddy Set to Make Transition from PC to iOS this September Posted by Jennifer Allen on July 28th, 2014 [ permalink ] | Read more »
PlanetHD
PlanetHD By Nadia Oxford on July 28th, 2014 Our Rating: :: SPACE MADNESSUniversal App - Designed for iPhone and iPad PlanetHD will keep players busy for a while, though its unpredictable physics are a handful to deal with.   | Read more »
This Week at 148Apps: July 21-25, 2014
Another Week of Expert App Reviews   At 148Apps, we help you sort through the great ocean of apps to find the ones we think you’ll like and the ones you’ll need. Our top picks become Editor’s Choice, our stamp of approval for apps with that little... | Read more »
Reddme for iPhone - The Reddit Client (...
Reddme for iPhone - The Reddit Client 1.0 Device: iOS iPhone Category: News Price: $.99, Version: 1.0 (iTunes) Description: Reddme for iPhone is an iOS 7-optimized Reddit client that offers a refreshing new way to experience Reddit... | Read more »

Price Scanner via MacPrices.net

iOS 8 and OS X 10.10 To Support DuckDuckGo As...
Writing for Quartz, Dan Frommer reports that Apple’s forthcoming iOS 8 and OS X 10.10 operating systems version updates will allow users to select DuckDuckGo as their default search engine. He notes... Read more
U.K. Hospital Using iPods and iPads To Record...
British news journal GazetteLive’s. Ian McNeal notes that the old “an apple a day keeps the doctor away” proverb is being turned on its head at http://southtees.nhs.uk/hospitals/james-cook/ James... Read more
13-inch 2.5GHz MacBook Pro on sale for $1099,...
Best Buy has the 13″ 2.5GHz MacBook Pro available for $1099.99 on their online store. Choose free shipping or free instant local store pickup (if available). Their price is $100 off MSRP. Price is... Read more
Roundup of Apple refurbished MacBook Pros, th...
The Apple Store has Apple Certified Refurbished 13″ and 15″ MacBook Pros available for up to $400 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free. Their prices... Read more
Record Mac Shipments In Q2/14 Confound Analys...
A Seeking Alpha Trefis commentary notes that Apple’s fiscal Q3 2014 results released July 22, beat market predictions on earnings, although revenues were slightly lower than anticipated. Apple’s Mac’... Read more
Intel To Launch Core M Silicon For Use In Not...
Digitimes’ Monica Chen and Joseph Tsai, report that Intel will launch 14nm-based Core M series processors specifically for use in fanless notebook/tablet 2-in-1 models in Q4 2014, with many models to... Read more
Apple’s 2014 Back to School promotion: $100 g...
 Apple’s 2014 Back to School promotion includes a free $100 App Store Gift Card with the purchase of any new Mac (Mac mini excluded), or a $50 Gift Card with the purchase of an iPad or iPhone,... Read more
iMacs on sale for $150 off MSRP, $250 off for...
Best Buy has iMacs on sale for up to $160 off MSRP for a limited time. Choose free home shipping or free instant local store pickup (if available). Prices are valid for online orders only, in-store... Read more
Mac minis on sale for $100 off MSRP, starting...
Best Buy has Mac minis on sale for $100 off MSRP. Choose free shipping or free instant local store pickup. Prices are for online orders only, in-store prices may vary: 2.5GHz Mac mini: $499.99 2.3GHz... Read more
Global Tablet Market Grows 11% in Q2/14 Notwi...
Worldwide tablet sales grew 11.0 percent year over year in the second quarter of 2014, with shipments reaching 49.3 million units according to preliminary data from the International Data Corporation... Read more

Jobs Board

Sr Software Lead Engineer, *Apple* Online S...
Sr Software Lead Engineer, Apple Online Store Publishing Systems Keywords: Company: Apple Job Code: E3PCAK8MgYYkw Location (City or ZIP): Santa Clara Status: Full 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
Sr. Product Leader, *Apple* Store Apps - Ap...
**Job Summary** Imagine what you could do here. At Apple , great ideas have a way of becoming great products, services, and customer experiences very quickly. Bring 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* 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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.