TweetFollow Us on Twitter

OD Contain Yourself
Volume Number:12
Issue Number:1
Column Tag:New Apple Technology

OpenDoc: Contain Yourself ...

Updating applications to work with OpenDoc

By Eric Soldan, Apple Developer Technical Support

It’s time to be an OpenDoc™ container application. It’s not too soon, and it’s not too late. So how do you decide if your application should be an OpenDoc container application or not? Here’s an easy test:

• Will your application benefit from Internet access?

If the answer is yes, then being an OpenDoc container application is probably the right thing to do. By becoming an OpenDoc container application, you automatically get the benefits of everything that is OpenDoc, including CyberDog, which will provide component oriented Internet clients and other Internet services. Now is not the time to ignore the Internet bandwagon. It’s worth jumping on. The only question remaining is how to jump. Do you learn Open Transport and MacTCP and recode your entire application to support the Internet? Or do you look for alternatives, like OpenDoc?

A logical question therefore would be: “Is OpenDoc really the fastest way to add Internet to your application?” Adding Internet support with OpenDoc boils down to adding basic OpenDoc support; in this article we will evaluate the difficulty of adding OpenDoc to an existing application. Then you can decide.

The Container Application Library: Your Friend.

CALib, the Container Application Library, has been evolving for a while. It’s looking really good right now. Joshua Susser, of OpenDoc engineering, and I have been adding CALib support to an application I originally developed in Developer Tech Support called DTS.Draw. I wrote DTS.Draw years ago, without ever considering the possibility of adding something like OpenDoc later. DTS.Draw’s document model, while flexible, is a closed model, so adding OpenDoc support is therefore a very interesting test case for CALib.

It turns out that the amount of additional coding necessary is minimal. However, due to CALib’s flexibility, there were many development issues that had to be discussed for quite a while. If these discussions were not held, the implementation would not have been as robust. I will present what we’ve learned from these discussions.

First, let’s talk about DTS.Draw for a while. When adding OpenDoc, it’s important to understand how the existing application works. Since you are probably not familiar with DTS.Draw, I’ll give you a quick overview.

DTS.Draw is an AppsToGo framework based application. AppsToGo is an object-oriented C framework written by DTS. DTS.Draw is also all C code. DTS.Draw is a “standard” drawing application. It has a tool palette of a variety of drawing objects. It has a hierarchical document architecture which allows for grouping and ungrouping of draw objects. It supports infinite undo. It supports drag and drop.

When a document is saved, the object hierarchy is flattened and streamed to the file. When a drag-out occurs, the selected objects are streamed into a handle; this stream represents a sub-hierarchy of the document. This sub-hierarchy is then just a flavor for the clippings file. When a file is opened (or a drag-in occurs), the hierarchy is reconstructed. Very standard stuff.

Here’s a diagram of a representative DTS.Draw document:

For a save, the objects in the hierarchy are streamed in simple tree-walk order, as indicated by the numbering. The drag objects 2, 4, 5, and 6 can be any supported object. The current implementation of DTS.Draw allows for line, rect, round rect, oval, and pie objects. More can be added of course, and this exactly is how we added OpenDoc support to DTS.Draw; we just added a new OpenDoc Part object into the application. The difference with this object is that the content isn’t anything specifically manipulated by DTS.Draw. It is simply a part the user adds to the document. The DTS.Draw object just serves as a “container” for the OpenDoc part. If a user were to add two OpenDoc parts to the above DTS.Draw document, the document hierarchy might end up looking something like:

The implementation in DTS.Draw is relatively simple. The Part object inherits from DTS.Draw’s native rect object. The difference is that it has a much more complex content that the rect object in the standard DTS.Draw application. The content of the Part object can be any OpenDoc part, of course. The content of the Part object is managed using CALib. Given this information, look at this diagram and see exactly what the relationship between the Part objects and CALib :

As shown above, there’s a lot more to the DTS.Draw document now. Fortunately, most of the new stuff is managed by CALib and OpenDoc. CALib uses a “proxy part” to contain the parts that are placed into the document content. Normally, OpenDoc expects there to be a root part that is an OpenDoc container, but since other parts are “embedded” into your application’s non-OpenDoc document, a proxy container part is created and the “embedded” parts are stored in there. The proxy part, as far as OpenDoc is concerned, is what actually contains the other parts that are referenced from the DTS.Draw native content.

The difficulty here is that the proxy part isn’t “real.” It has no geometry information, and OpenDoc doesn’t automatically bind the proxy part to any code, as is the normal case with OpenDoc parts. Thus, OpenDoc is unable to offer the full range of services for the embedded parts. But this is okay. The proxy part isn’t all that smart, nor should it be. It is simply a part that is used by CALib to have somewhere to put the other parts.

So it’s up to DTS.Draw to control the layout and presentation for the OpenDoc parts. Only the application knows the geometry information for the embedded parts, which is stored in DTS.Draw Part objects. The DTS.Draw Part object also has a persistent reference to the corresponding object embedded in the proxy part. Fortunately, CALib offers API calls to help manage these and other OpenDoc interactions, so the above and other OpenDoc related tasks are relatively simple to implement.

For example, to perform screen updates and such, DTS.Draw simply tells CALib to tell the part to draw itself. All that is needed is the Part Ref value, which indicates to CALib which embedded part to draw. The application doesn’t have to care what it references. It references something, and that thing knows how to draw itself.

Streaming Your Objects

Given that the proxy part can’t really deal with containing parts by itself, (i.e., without your application doing the geometry), the proxy part and its embedded parts do not constitute a valid OpenDoc document. This is important when we decide what type of document you want to create when you save it to disk.

The choices are:

1. A Bento stream placed inside your document.

2. Your document stream placed inside a Bento document.

The right choice will of course depend on your application. For DTS.Draw, we chose 1. Choice 1 is closer to existing Macintosh applications. Choice 2 is closer to regular OpenDoc parts. If you were to consider the development choices, from application to OpenDoc part, with CALib applications somewhere in between, your choices look something like this:

Application:

Standard document architecture.

CALib-friendly application:

Standard document architecture with embedded Bento stream.

CALib-savvy application:

Bento document with application data streamed into an OpenDoc storage unit
value.

OpenDoc part editor:

Bento document with part editor data residing in an OpenDoc storage unit.

When considering drag and drop, the above categories are very important. When applications drag something to the desktop, a clippings file is created. When OpenDoc parts are dragged to the desktop, an OpenDoc document is created, instead of a clippings file. This is an important distinction between applications and OpenDoc. Applications create clippings files because they are a standard and flexible intermediate format. OpenDoc parts create OpenDoc documents on a drag-out because an OpenDoc document is already a universal format. There’s no reason to resort to creating a clippings file.

If you are a CALib application, the choice is no longer so clear. Our suggestion is to base your drag-out decision on whether your document format is still “native,” or if you use a Bento file with your native content embedded.

So, if you are a CALib application, what is one to do on a drag-out? The answer lies in the document type. If the document type is an OpenDoc document (CALib-savvy), then the drag-out type is OpenDoc document. If the document type is a standard document (CALib-friendly), then the drag-out type is a clippings file.

DTS.Draw’s native content is simply streamed out. After adding CALib support, this is still the case. The Bento document is streamed out, as well. Here’s the new document format:

Byte offset Description

0 to 3: length of Bento stream

4 to nativeContent - 1: Bento stream

nativeContent to EOF: native content stream, i.e.,
DTS.Draw old format

There was much discussion as to whether or not the Bento stream should be at the front of the file or the end. It turns out that you can do some interesting things if it is at the front of the file. Try out this situation:

1. Your machine has CALib. You add some OpenDoc parts to your DTS.Draw document.

2. You then send the document to some poor individual who doesn’t have CALib or OpenDoc.

Guess what? If the Bento stream is in the front of the file, the unfortunate individual can still use the file with your CALib-friendly application. The user without CALib can actually edit the native content and save it out. The native content changes size, but hey, it’s on the end of the file.

On machines that don’t have CALib but need to display Part objects in their content, the standard look for “NoPart” should be used. This is what OpenDoc displays when an editor for a particular part isn’t available. In the case of CALib applications, it works for when CALib isn’t available, as well.

Making your CALib-based documents work on machines with or without CALib takes a bit of extra coding, but from a version control standpoint, it is well worth it. Documents can go anywhere. A CALib document can be given to someone without CALib. That this person can actually edit the native content of the document, and then give the document back to you, is pretty nifty.

On machines where CALib isn’t available, users obviously won’t be able to add any new parts to the document. They will be restricted to editing the native content. However, this may include moving part objects around that someone else was nice enough to put in the document. This works. Remember that the geometry information is stored in the native objects, which all users can edit. The proxy part doesn’t handle the geometry. In addition, the user can delete the Part objects (which are displayed using the “No Part” look). This of course means that there is data orphaned in the Bento stream. (Since the user doesn’t have CALib, there is no way their machine can modify the Bento stream.) Fortunately, the stream will be compacted the next time the document is saved on a machine with CALib.

With some extra work, you can even allow the user to resize the Part objects without CALib. When this occurs, the information in the Bento stream for that part is no longer up to date. The native content object will need to be flagged as having been resized. When the document is opened on a machine with CALib, these objects will need to have their frame information renegotiated and resolved to reflect their new size.

We’ve been discussing types of editing that can still occur to a CALib document Part object when CALib isn’t available. There are, of course, edits that can’t be performed. Here are two:

1. Dragging that includes a Part object. Streaming the drag data must include streaming the Bento information into the flavor. This can’t be done without CALib. All that’s in the native object is a persistent reference to somewhere inside the Bento stream. You can’t resolve the reference without CALib.

2. Copying the object. At first, it would seem that you would just copy the native content object. It has a persistent reference. Both copies of the object would then point to the same Bento information, i.e., the part. This is a bad thing. When opened again on a CALib machine, each copy of the part should be independent of the other. (You could flag the copy as an unresolved copy, and then clone the object when the document is next opened on a CALib machine.)

As you can see from this discussion, CALib can be used to add OpenDoc capability to your existing applications without radically changing the way they work. The actual amount of code added to an application isn’t all that bad, either. Of course, this will vary, depending on architecture and document content, but most likely, it’s not a complete recode with major modifications throughout your application. Look for the latest CALib and CASample sample code on the OpenDoc DR4 release.

Have fun out there!

 
AAPL
$100.86
Apple Inc.
-0.77
MSFT
$46.76
Microsoft Corpora
+0.52
GOOG
$579.95
Google Inc.
+6.85

MacTech Search:
Community Search:

Software Updates via MacUpdate

Capture One Pro 8.0.0.433 - RAW workflow...
Capture One Pro 8 is a professional RAW converter offering you ultimate image quality with accurate colors and incredible detail from more than 300 high-end cameras -- straight out of the box. It... Read more
Adobe Acrobat Pro 11.0.09 - Powerful PDF...
Adobe Acrobat allows users to communicate and collaborate more effectively and securely. Unify a wide range of content in a single organized PDF Portfolio. Collaborate through electronic document... Read more
Adobe Reader 11.0.09 - View PDF document...
Adobe Reader allows users to view PDF documents. You may not know what a PDF file is, but you've probably come across one at some point. PDF files are used by companies and even the IRS to... Read more
iFFmpeg 4.6.1 - Convert multimedia files...
iFFmpeg is a graphical front-end for FFmpeg, a command-line tool used to convert multimedia files between formats. The command line instructions can be very hard to master/understand, so iFFmpeg does... Read more
NTFS 11.3.62 - Provides full read and wr...
Paragon NTFS breaks down the barriers between Windows and OS X. Paragon NTFS effectively solves the communication problems between the Mac system and NTFS, providing full read and write access to... Read more
OS X Yosemite 10.10 DP8 - Developer Prev...
Note: This is a Developer Preview. You must be a registered Apple Mac Developer to download this update. You can also sign up for the free OS X Beta Program to download and preview public beta... Read more
FotoMagico 4.5 - Powerful slideshow crea...
FotoMagico lets you create professional slideshows from your photos and music with just a few, simple mouse clicks. It sports a very clean and intuitive yet powerful user interface. High image... Read more
Screenshot Path 1.2.1 - Change the defau...
Screenshot Path lets you change the folder where OS X saves screenshots. Screenshots are saved by default to the user’s desktop. This is handy for the occasional screenshot but those looking to take... Read more
Fantastical 1.3.16 - Create calendar eve...
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
GIMP 2.8.14 - Powerful, free image editi...
GIMP is a multi-platform photo manipulation tool. GIMP is an acronym for GNU Image Manipulation Program. The GIMP is suitable for a variety of image manipulation tasks, including photo retouching,... Read more

Latest Forum Discussions

See All

Zynga Unveils First Look at Looney Tunes...
Zynga Unveils First Look at Looney Tunes Dash! Posted by Ellis Spice on September 16th, 2014 [ permalink ] Be vewy, vewy qwiet. I’m hunting wunners featuwing wabbits, and luckily, it’s duck season wunner season. | Read more »
Guardians on the Go – How to Connect to...
At this point I’m relatively certain most of the country is familiar with Destiny. And for those looking to augment their game a bit, Bungie has changed their Bungie Mobile Companion App to Destiny Companion. | Read more »
Kunin Review
Kunin Review By Jordan Minor on September 16th, 2014 Our Rating: :: SHURIKEN DO ITUniversal App - Designed for iPhone and iPad Kunin is a nervous test of ninja reflexes.   Developer: Dodreams Price: FREE Version Reviewed: 1.0.1... | Read more »
4 KEMCO Titles are Just $0.99 for a Limi...
4 KEMCO Titles are Just $0.99 for a Limited Time Posted by Jessica Fisher on September 16th, 2014 [ permalink ] KEMCO RPGs Destiny Fantasia, Infinite Dunamis, Bonds of the Sk | Read more »
Introducing Flash, the Latest Wearable F...
Introducing Flash, the Latest Wearable Fitness Monitor from Misfit Posted by Jessica Fisher on September 16th, 2014 [ permalink ] The Misfit Flash is the newly-released fitness and sleep monitor from | Read more »
Hyper Trip Review
Hyper Trip Review By Jennifer Allen on September 16th, 2014 Our Rating: :: HYPER TWITCHYUniversal App - Designed for iPhone and iPad Tough and unforgiving, Hyper Trip is a bit like Snake – if Snake was really harsh.   | Read more »
Collectible Card Game Earthcore: Shatter...
Collectible Card Game Earthcore: Shattered Elements is Set to Arrive on iOS in 2015 Posted by Ellis Spice on September 16th, 2014 [ permalink ] Polish developers | Read more »
Boogey Boy Review
Boogey Boy Review By Jennifer Allen on September 16th, 2014 Our Rating: :: PRETTY BUT BASICUniversal App - Designed for iPhone and iPad It looks delightful but lack of Game Center support and more variety really affects the fun... | Read more »
Vizzywig 4K (Photography)
Vizzywig 4K 1.0 Device: iOS iPhone Category: Photography Price: $999.99, Version: 1.0 (iTunes) Description: REQUIRES: iOS 7 on iPhone 5S with 32GB or 64GB. (Do not use iOS 8)The world's FIRST mobile 4K video capture, editing and... | Read more »
The Sleeping Prince Review
The Sleeping Prince Review By Jennifer Allen on September 15th, 2014 Our Rating: :: RESTRICTIVE KINGDOM SAVINGUniversal App - Designed for iPhone and iPad The Sleeping Prince looks and feels great to play, but its lack of peril and... | Read more »

Price Scanner via MacPrices.net

Sprint offers 16GB iPad mini for $199.99 with...
Sprint is offering 1st generation 16GB iPad minis for $199.99 with a 2-year service agreement. Standard MSRP for this iPad is $429. Their price is the lowest available for this model. Read more
2.5GHz Mac mini remains on sale for $549, sav...
B&H Photo has the 2.5GHz Mac mini on sale for $549.99 including free shipping. That’s $50 off MSRP, and B&H will also include a free copy of Parallels Desktop software. NY sales tax only. Read more
Apple refurbished iMacs available for up to $...
The Apple Store has Apple Certified Refurbished iMacs available for up to $300 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free. These are the best prices on... Read more
13″ 2.5GHz MacBook Pro offered for $100 off M...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $999.99 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Read more
Free GIMP Professional Grade Graphics App Ver...
The latest 2.8.14 version of the oddly-named GIMP (acronym for: GNU Image Manipulation Program) open source, high-end image editing and creation alternative to Adobe’s Photoshop and refuge from... Read more
Apple Announces Record Pre-orders for iPhone...
Apple has released metrics showing a record number of first day pre-orders of iPhone 6 and iPhone 6 Plus, with over four million sold in the first 24 hours. Demand for the new iPhones exceeds the... Read more
10% off iPhone 6 and 6 Plus Otterbox cases
Get 10% off on popular Otterbox iPhone 6 and iPhone 6 Plus cases at MacMall through September 19th. Use code OTTERBOX10 to see the discount. Read more
15-inch MacBook Pros on sale for up to $125 o...
Amazon has the new 2014 15″ Retina MacBook Pros on sale for up to $125 off MSRP including free shipping: - 15″ 2.2GHz Retina MacBook Pro: $1899.99 save $100 - 15″ 2.5GHz Retina MacBook Pro: $2374... Read more
27-inch 3.2GHz iMac on sale for $1698, $101 o...
Abt has the 27″ 3.2GHz iMac on sale for $1698 including free shipping. Their price is $101 off MSRP. Read more
More To Making A Larger iPad Than Expanded Sc...
CNET’s Ross Rubin has posted a thoughtful analysis of prospects for a larger display iPad Pro, noting that Microsoft and Samsung currently have the large-display touchscreen tablet category to... Read more

Jobs Board

*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) - 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) - 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) - 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) - 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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.