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.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Monolingual 1.6.4 - Remove unwanted OS X...
Monolingual is a program for removing unnecesary language resources from OS X, in order to reclaim several hundred megabytes of disk space. If you use your computer in only one (human) language, you... Read more
CleanApp 5.0 - Application deinstaller a...
CleanApp is an application deinstaller and archiver.... Your hard drive gets fuller day by day, but do you know why? CleanApp 5 provides you with insights how to reclaim disk space. There are... Read more
Fantastical 2.0 - Create calendar events...
Fantastical is the Mac calendar you'll actually enjoy using. Creating an event with Fantastical is quick, easy, and fun: Open Fantastical with a single click or keystroke Type in your event details... Read more
Cocktail 8.2 - General maintenance and o...
Cocktail is a general purpose utility for OS X 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
Direct Mail 4.0.4 - Create and send grea...
Direct Mail is an easy-to-use, fully-featured email marketing app purpose-built for OS X. It lets you create and send great looking email campaigns. Start your newsletter by selecting from a gallery... Read more
jAlbum Pro 12.6 - Organize your digital...
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
jAlbum 12.6 - Create custom photo galler...
With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code! Beginner-friendly, with pro results Simply drag and drop photos into groups, choose a design... Read more
Lyn 1.5.9 - Lightweight image browser an...
Lyn is a lightweight and fast image browser and viewer designed for photographers, graphic artists and Web designers. Featuring an extremely versatile and aesthetically pleasing interface, it... Read more
Sublime Text 3080 - Sophisticated text e...
Sublime Text is a sophisticated text editor for code, markup, and prose. You'll love the slick user interface, extraordinary features, and amazing performance. Goto Anything. Use Goto Anything to... Read more
WALTR 1.0.11 - Drag-and-drop any media f...
WALTR is designed to make it easy to upload and convert any music or video file to an iPad or iPhone format for native playback. It supports a huge variety of media file types, including MP3, MP4,... Read more

Bio Inc's New Expansion is Infectin...
Bio Inc., by DryGin Studios, is the real time strategy game where you infect a human body with the worst virus your evil brain can design. Recently, the game was updated to add a whole lot of new features. Now you can play the new “Lethal”... | Read more »
The Monocular Minion is Here! Despicable...
Despicable Me: Minion Rush, by Gameloft, is introducing a new runner to the mix in their latest update. Now you can play as Carl, the prankster minion. Carl has a few new abilities to play with, including running at a higher speed from the start.... | Read more »
Dungeon of Madness (Games)
Dungeon of Madness 1.0.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0.0 (iTunes) Description: Dungeon of Madness is an action game where you rotate tiles to create our own route. Help the hero by connecting the... | Read more »
Filters for iPhone (Photography)
Filters for iPhone 1.0 Device: iOS iPhone Category: Photography Price: $.99, Version: 1.0 (iTunes) Description: | Read more »
Jump'N'Shoot Attack (Games)
Jump'N'Shoot Attack 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: A mobile game for gamers! Join Louise Lightfoot, the legendary "Master of Jumping and Shooting", on her mission to save... | Read more »
Space Bounties Inc. (Games)
Space Bounties Inc. 1.4 Device: iOS Universal Category: Games Price: $1.99, Version: 1.4 (iTunes) Description: SuperGameDroid: 4/5 "Satisfying futuristic RPG combat, high replay value, and a heavy dose of nostalgia make Space... | Read more »
Gamebook: Pocket RPG (Games)
Gamebook: Pocket RPG 1.0.11 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.11 (iTunes) Description: Walk into the Land of Lanthir Lamath ruled by wicked skeletons and fight for your life in a thrilling adventure.... | Read more »
Kids Can Mix, Match, and Catch with Tata...
Tatadada MixMatch, by Tatadada Ltd, is a mobile version of the classic game of mix & match. The game uses brightly colored creatures to train your children's pattern matching skills and hand-eye coordination. It's aimed at children around age 5... | Read more »
The Trace: Murder Mystery Game (Games)
The Trace: Murder Mystery Game 1.2.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.2.0 (iTunes) Description: | Read more »
This Week at 148Apps: March 16-20, 2015
Spring Roars In At 148Apps How do you know what apps are worth your time and money? Just look to the review team at 148Apps. We sort through the chaos and find the apps you're looking for. The ones we love become Editor’s Choice, standing out above... | Read more »

Price Scanner via MacPrices.net

Logitech Says MX Master Is Its Most Advanced...
Logitech’s new MX Master Wireless Mouse incorporates the best of Logitech’s many computer mouse innovations into a striking hand-sculpted design. The company claims that the MX Master creates a new... Read more
Save up to $300 on a new Mac, $30 on an iPad,...
Purchase a new Mac or iPad at The Apple Store for Education 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
Apple refurbished 2014 MacBook Airs available...
The Apple Store lowered prices on Apple Certified Refurbished 2014 MacBook Airs recently, with models now available starting at $679. An Apple one-year warranty is included with each MacBook, and... Read more
Mac Notebook Evolution; A Desktop Replacement...
More often than not right from the beginning, Apple’s Macs have tended to skew toward small. The original Macs were called “compacts,”, and notwithstanding a few exceptions like the honking Big Mac... Read more
13-inch 1.4GHz/128GB MacBook Air (Apple refur...
The Apple Store has Apple Certified Refurbished 2014 13″ 1.4GHz/128GB MacBook Airs available for $759 including free shipping plus Apple’s standard one-year warranty. Their price is $240 off original... Read more
YEP! Alternative Browser for iOS Now Supports...
Pfaeffikon, Switzerland based Power App AG has announced the release of an update to their Yep! Web Browser (v1.3.0) for iOS8 iPhone and iPad. Yep! hit the App Store shortly after the release of iOS... Read more
15-inch Retina MacBook Pros on sale for up to...
B&H Photo has the new 2014 15″ Retina MacBook Pros on sale for up to $250 off MSRP for a limited time. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $... Read more
Clearance 13-inch Retina MacBook Pros availab...
B&H Photo has leftover 2014 13″ Retina MacBook Pros on sale for up to $250 off original MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.6GHz/128GB Retina MacBook Pro: $1098... Read more
Clearance 2014 MacBook Airs on sale for up to...
B&H Photo has MacBook Airs on sale for up to $180 off original MSRP. Shipping is free, and B&H charges NY sales tax only: - 11″ 128GB MacBook Air: $789.99 110 off original MSRP - 11″ 256GB... Read more
Apple refurbished Time Capsules available for...
The Apple Store has certified refurbished Time Capsules available for $100 off MSRP. Apple’s one-year warranty is included with each Time Capsule, and shipping is free: - 2TB Time Capsule: $199, $100... Read more

Jobs Board

*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - D...
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* Systems Engineer - Pre Sales, Educat...
…is responsible for proactively providing technical expertise to drive sales of Apple solutions into assigned accounts. The SE architects, validates, and assists in Read more
Sr. Technical Services Consultant, *Apple*...
**Job Summary** Apple Professional Services (APS) has an opening for a senior technical position that contributes to Apple 's efforts for strategic and transactional Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.