TweetFollow Us on Twitter

PP Documents
Volume Number:12
Issue Number:4
Column Tag:Getting Started

PowerPlant and Documents

By Dave Mark, MacTech Magazine Regular Contributing Author

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.

Last month, we implemented a window containing a scrolling TextEdit view. Though you could type text in a window, there was no way of saving the text out as a file or of loading a text file into a text editing window. What’s missing here is the concept of a document. PowerPlant features a sophisticated set of document-handling classes that allow you to quickly tie a file to a window. Each file/window pairing is known as a document. Although PowerPlant does support a more complex model (multiple windows tied to a single file, for example), the most common document approach ties a single file to a single window, all controlled by the LSingleDoc class.

This month, we’re going to examine a sample application that ships with CodeWarrior. The application is called DocDemo, and it implements a simple TextEdit window that supports most standard document behaviour. That is, you can Save a document, Save As... under a new name, Open an existing document, and Print a document. DocDemo supports Apple events and is recordable. You can find DocDemo on the CodeWarrior CD. On CodeWarrior 8, it is in a folder called Document Demo.

My original goal for this month’s column was to add the LSingleDoc class to last month’s program, allowing you to save your text window as a file and open an existing file in a text window. But when I saw DocDemo, I changed my mind. DocDemo does everything I wanted to do, but also adds printing and great Apple event support. This is definitely a great learning program. Cool!

Getting Started with DocDemo

Before you go any further, you might want to find a copy of DocDemo on your CodeWarrior disk (or download it from whatever site you go to to pick up the Getting Started source code each month [such as - man]). Figure 1 shows the project window for the PowerPC version of DocDemo. Take a look at the files grouped under the name Application. The file CDocDemoApp.cp contains main() and the member functions that make up our main application class. CDocDemoApp is derived from LDocApplication, which is derived from LApplication. If you plan on building an application that supports multiple documents, CDocDemoApp.cp makes a great starting point.

(Remember, a class that starts with “L” belongs to PowerPlant. All the classes that you add to your PowerPlant programs will start with “C”.)

Figure 1. The DocDemoPPC.µ project window

Where CDocDemoApp.cp implements the application, the file CTextDoc.cp implements a single text-based document. CTextDoc is derived from LSingleDoc, which is derived from LDocument.

CDirtyText.cp implements the actual text stream, the text stored in memory that appears in one of the DocDemo windows. The word “dirty” refers to the state of a text stream, either changed since the last save (dirty) or not.

Later in the column we’ll step through each of these three source code files, pointing out the highlights. The remaining three files in the Application group are resource files. Notice that the Constructor resources are stored separately from the rest of the resources. As mentioned in a previous column, this is a good idea. When you double-click on the file DocDemo.rsrc, your favorite resource editor is launched (in this case, the creator code of DocDemo.rsrc is set to launch Resorcerer - feel free to change it to use ResEdit if that’s your preference). When you double-click on the file DocDemo.PPob, Constructor is launched.

Figure 2. The main window for DocDemo.PPob

Take some time to look through the resource files, especially the Constructor file. If you haven’t seen it yet, this would be an excellent time to check out Constructor 2.1, the version that shipped on CW8. It has a cool new look and a great new menu editor. Yup, Constructor now does menus! Figure 2 shows the main Constructor window for DocDemo.PPob. Very nice...

The main view of interest here is the one named “Text Window”. If you double-click on it, you’ll see something very similar to the scrolling text pane we created last month, with an LScroller enclosing an LTextEdit pane. Figure 3 shows the pane info window for the LTextEdit pane. Notice that the Pane ID is set to the four byte value 'Text' and that the Text ID checkbox is checked. When the Text ID checkbox is checked, the value in the Pane ID field is represented as a sequence of 4 characters (like a resource type) instead of as a long integer.

Notice also that the Class ID is set to the four byte value 'Dtxt'. This value will come into play when we register our classes in the source code. We’ll pass this value as a parameter to URegistrar::RegisterClass() in the CDocDemoApp constructor. You’ll see this in a bit, when we explore the project source code.

Figure 3. The LTextEdit pane info window for the pane

Running DocDemo

Take some time to put DocDemo through its paces. The important things to test are the ability to save and reopen text files. If you have AppleScript installed on your machine (and you should), run the Script Editor, click the Record button, then run DocDemo. While recording, create a new window, type some text, then save the document to disk. Go back to the Script Editor and click the Stop button. Figure 4 shows the results when I did this on my Mac. The line saying “make new document” was a result of selecting New from the File menu. The line following it was a result of doing a Save. Notice that the action of typing my text was not recorded. Once you’ve been through the code, see if you can figure out why this action wasn’t captured and how to make this happen.

Figure 4. A script recorded using Script Editor
while running DocDemoPPC

Here’s another interesting thing to try. You may experience an unrecoverable crash with this one, so be sure you save any open docs first! In DocDemo, open a new window, type some text, then save the document on your hard drive. Without closing the window, select Open from the File menu. Select the file you just saved (it’s already open, right?) from the SFGetFile list, then sit back and watch some exception handling kick in. Remember that option-Apple-escape forces a quit; you might end up using it. You might want to repeat this experiment with the debugger turned on.

OK, enough play. Let’s check out the source code.


You’ll notice a strong similarity between CDocDemoApp and last month’s PPTextEdit.cp file. While PPTextEdit’s application class, CPPStarterApp, was derived from LApplication, CDocDemoApp is derived from LDocApplication (LDocApplication is derived from LApplication). Here are some important things to look at as you go through the source in CDocDemoApp.cp:

• CDocDemoApp overrides OpenDocument(), MakeNewDocument(), ChooseDocument(), ObeyCommand(), and FindCommandStatus(). ObeyCommand() and FindCommandStatus() should be familiar to you from previous columns. In DocDemo, they don’t do much, since we haven’t added any commands specific to DocDemo.

• OpenDocument() gets called on an 'odoc' Apple event and opens the file specified in the incoming FSSpec. In a truly recordable application, OpenDocument() should never be called directly. When you want to do an open, you should post an 'odoc' event, which will cause OpenDocument() to get called. Remember, Apple events are what get recorded. Without the Apple event, the process of opening a document won’t be recorded. To post an 'odoc' Apple event, call LDocApplication::SendAEOpenDoc().

• MakeNewDocument() gets called in response to a kAECreateElement Apple event. When you select New fom the File menu, PowerPlant sends itself a kAECreateElement Apple event. Again, this is vital if you want your app to be recordable. To see this in action, take a look in CDocDemoApp::ObeyCommand(). Notice that cmd_New is not handled and that this causes a call of LDocApplication::ObeyCommand(). LDocApplication::ObeyCommand() sends the kAECreateElement Apple event in response to cmd_New. MakeNewDocument() uses new to create a new CTextDoc.

• Take a look at the ChooseDocument() source code:

 StandardFileReply macFileReply;
 SFTypeList typeList;
 typeList[0] = 'TEXT';
 ::StandardGetFile(nil, 1, typeList, &macFileReply);
 if (macFileReply.sfGood) {

There are a couple of interesting points here. First, notice that ChooseDocument() calls OpenDocument() directly. This action will now not be recordable (try it). Instead, ChooseDocument should pass macFileReply.sfFile to LDocApplication::SendAEOpenDoc().

UDesktop::Deactivate() calls Deactivate() for every window object in your app. This is needed since StandardGetFile() eats all the events as soon as it is called and your application windows never get a chance to get deactivated. If you don’t call UDesktop::Deactivate(), then when the StandardGetFile() dialog appears, your previously frontmost window will still appear in its active state (the title bar will still have stripes, for example). This is purely for aesthetics.

UDesktop::Activate() calls FrontWindow() and calls that window’s Activate(), returning things to the way they were before the call to UDesktop::Deactivate().

Note: If you have floating windows in your application, replace the file UDesktop.cp in your project window with UFloatingDesktop.cp. UFloatingDesktop.cp uses a slightly different mechanism for activate/deactivate that takes floating windows into account. This file is a little bigger and causes your built app to be a little larger, so don’t make the switch unless you use floating windows.

Take a look at the call of ::StandardGetFile() in ChooseDocument(). The two colons before the function name tell the compiler that the function is a global function. By convention, we always put two colons in front of a direct Toolbox call; this helps us discriminate between Toolbox and member function calls.

• ObeyCommand() and FindCommandStatus() don’t do much here. You’ll want to add stuff to these functions as you add commands and menus to your own applications.

• Take a look at the other member functions in LDocApplication (the ones we didn’t override). They are mostly there to handle Apple events and printing, and are definitely worth reviewing, especially if you are trying to learn how to work with Apple events.


CTextDoc is derived from LSingleDoc which is derived from LDocument. CTextDoc implements a single DocDemo document. Here are the highlights from the source code file:

• CTextDoc overrides IsModified(), DoAESave(), DoSave(), DoRevert(), and DoPrint().

• Take a look at the function CDocDemoApp::Open-Document():

 FSSpec *inMacFSSpec)
 CTextDoc *theDoc = new CTextDoc(this, inMacFSSpec);

Notice that this code causes the CTextDoc constructor to be called. The CTextDoc constructor calls CreateWindow() to create a new window, passing it the 'PPob' resource ID 200 as a parameter. Here’s the constructor:

 LCommander *inSuper,
 FSSpec *inFileSpec)
 : LSingleDoc(inSuper)
 // Create window for our document
 mWindow = LWindow::CreateWindow(WIND_TextDoc, this);
 // Specify that the text view should
 // be the Target when the Window
 // is activated
 mTextView = (CDirtyText*) mWindow->FindPaneByID('Text');
 if (inFileSpec == nil) {
 NameNewDoc();   // Set name of untitled window
 } else {
 OpenFile(*inFileSpec);   // Display contents of file in window

The call to FindPaneByID() returns a pointer to the LTextEdit pane object. The call to SetLatentSub() tells PowerPlant that the LTextEdit pane should be the target when the window is activated. Without this call, the text edit field would not become active when the window was activated, and the text insertion cursor would not flash (or even appear) until you clicked on the text edit pane. If you go back to last month’s example, you’ll see that that is exactly what happened. Take a few minutes, open up last month’s program, and see if you can add the code that makes the text cursor blink as soon as a new window is created.

• NameNewDoc() makes use of a pair of strings to name the new document “Untitled” or “Untitled x”. If there is no window named “Untitled”, NameNewDoc() makes that the new window name. If there already is a window named “Untitled”, NameNewDoc() looks for a window named “Untitled 1”, then “Untitled 2”, etc. As soon as it finds an open slot, that becomes the name of the new window.

Here’s the code:

 // Start with the default name (“untitled”)
 Str255 name;
 ::GetIndString(name, STRx_Untitled, 1);
 long num = 0;
 while (UWindows::FindNamedWindow(name) != nil) {
 // An existing window has the current name
 // Increment counter and try again

 ::GetIndString(name, STRx_Untitled, 2);
 Str15  numStr;
 ::NumToString(num, numStr);
 LString::AppendPStr(name, numStr);

The first call to ::GetIndString() returns the string “Untitled”. The second call returns the string “Untitled ” (note the space at the end of the string).

The call to mWindow->SetDescriptor() sets the window’s title. Don’t be fooled. SetDescriptor() has nothing to do with Apple event descriptors. Greg used the function name SetDescriptor() any time you were setting the title of an object to a value.

• Here’s the code to CTextDoc::OpenFile():

 FSSpec &inFileSpec)
 Try_ {
 mFile = new LFile(inFileSpec);
 Handle textH = mFile->ReadDataFork();
 mIsSpecified = true;
 Catch_(inErr) {
 delete this;
 } EndCatch_

Try_ is a macro Greg wrote to simulate exception handling before CodeWarrior supported exception handling. Now that exception handling is supported, Try_ is just defined as try and Catch_ is just defined as catch.

You will definitely want to spend some time curled up with a good book or paper on exception handling. Basically, here’s how this works. The try keyword tells the compiler to execute the block of code that follows the try. If the function throw() is called anywhere within that block (assuming there are no nested trys within the block), control is immediately transferred to the try’s matching catch block. The idea is, you can be way down in some code, encounter an error, and you jump out to the catch block attached to the code you are trying. The call to throw() is called, throwing an exception, and the catch block catches the exception. If the try code all runs without throwing an exception, the catch block is never entered.

By the way, the data member mIsSpecified indicates whether an existing file is tied to this document. If it isn‘t, and we do a Save, we need to do a StandardPutFile() to create a new file.

• IsModified() tells you whether the document is dirty (if you’ve made any changes to it since the last save):

 mIsModified = mTextView->IsDirty();
 return mIsModified;

mIsModified indicates whether the document is dirty. Note that in this case, whenever the pane is dirty, the document will be dirty. But what if we had two text panes, both stored in the same document? mIsModified would be based on either of the panes being dirty.

• DoAESave() gets called in response to a kAESave Apple event:

 FSSpec &inFileSpec,
 OSType inFileType)
 delete mFile;   // Kill existing file
 mFile = new LFile(inFileSpec);  // Make new file object
 OSType fileType = 'TEXT';// Find proper file type
 if (inFileType != fileType_Default) {
 fileType = inFileType;
    // Make new file on disk
 mFile->CreateNewDataFile(Creator_DemoDoc, fileType, 0);
 DoSave();// Write out data
    // Change window name
 mIsSpecified = true;// Document now has a specified file

DoAESave() uses a pretty simple file-saving strategy. It deletes the existing file, then creates a brand new file and writes the text out to it. This strategy isn’t very good if your computer happens to crash between deleting the file and writing out the new contents. In that case, you lose everything. A better strategy is to create the new file first, then delete the old one. There is a tech note somewhere that tells you the exactly right (i.e., official thought police) way to do this.

• DoSave() is a utility routine that actually copies the text out to an existing file.

 // Get text and write to file
 Handle textH = mTextView->GetTextHandle();
 StHandleLocker  theLock(textH);
 mFile->WriteDataFork(*textH, GetHandleSize(textH));
 mTextView->SetDirty(false);// Saving makes doc un-dirty

• DoRevert() reloads the text from the file into the text pane and refreshes mTextView:

 Handle textH = mFile->ReadDataFork();

• DoPrint() does printing. We’ll talk about that in a future column:

 LPrintout*thePrintout =
 LPlaceHolder  *textPlace = (LPlaceHolder*)
 textPlace->InstallOccupant(mTextView, atNone);
 delete thePrintout;


CDirtyText is derived from LTextEdit which is derived from LView. It is basically a version of LTextEdit that keeps track of whether it is dirty or not.

• CDirtyText overrides SetTextPtr() and UserChangedText().

• CDirtyText::CDirtyText() sets its dirty flag to false.

• CreateDirtyTextStream() is passed as a parameter to URegistrar::RegisterClass() (in the CDocDemoApp constructor) and is what allows us to create a CDirtyText object from a 'PPob':

 return (new CDirtyText(inStream));

• SetTextPtr() takes a pointer to a block of text and a length parameter and connects that block of text to this LTextEdit object:

 Ptr    inTextP,
 Int32  inTextLen)
 LTextEdit::SetTextPtr(inTextP, inTextLen);
 mIsDirty = false;

• UserChangedText() gets called whenever an action takes place on the LTextEdit view. If something has happened, if the pane is not already dirty, we have to change the menus to reflect the dirty status and flip the dirty flag. If the view is already dirty, we can’t make it any dirtier:

 if (!mIsDirty) {
 mIsDirty = true;

• IsDirty() just returns the status of the dirty flag.

• SetDirty() sets the dirty flag.

Till Next Month...

DocDemo is one of the most interesting PowerPlant examples I’ve seen. It is incredibly rich without being too difficult to understand. There are a bunch of ways you can extend this app, so take some time and start playing. Try adding a few menus to the DocDemo. Use Constructor to change the word-wrapping of the LTextEdit field. Try to change the font, style, and color of the text displayed in each document. I’ll see you next month...


Community Search:
MacTech Search:

Software Updates via MacUpdate

Paperless 3.0.6 - $69.95
Paperless is a digital documents manager. Remember when everyone talked about how we would soon be a paperless society? Now it seems like we use paper more than ever. Let's face it - we need and we... Read more
BetterTouchTool 3.141 - Customize multi-...
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
TextMate 2.0.rc.29 - Code/markup editor...
TextMate is a versatile plain text editor with a unique and innovative feature set which caused it to win an Apple Design Award for Best Mac OS X Developer Tool in August 2006 A rapidly growing... Read more
Little Snitch 4.4.1 - Alerts you about o...
Little Snitch gives you control over your private outgoing data. Track background activity As soon as your computer connects to the Internet, applications often have permission to send any... Read more
Little Snitch 4.4 - Alerts you about out...
Little Snitch gives you control over your private outgoing data. Track background activity As soon as your computer connects to the Internet, applications often have permission to send any... Read more
MPlayer OSX Extended 16 - Multimedia pla...
MPlayer OSX Extended is the future of MPlayer OSX. Leveraging the power of the MPlayer and FFmpeg open source projects, MPlayer OSX Extended aims to deliver a powerful, functional and no frills video... Read more
Google Chrome 75.0.3770.142 - Modern and...
Google Chrome is a Web browser by Google, created to be a modern platform for Web pages and applications. It utilizes very fast loading of Web pages and has a V8 engine, which is a custom built... Read more
Notability 4.0.4 - Note-taking and annot...
Notability is a powerful note-taker to annotate documents, sketch ideas, record lectures, take notes and more. It combines, typing, handwriting, audio recording, and photos so you can create notes... Read more
ffWorks 1.3.1 - Convert multimedia files...
ffWorks, focused on simplicity, brings a fresh approach to the use of FFmpeg, allowing you to create ultra-high-quality movies without the need to write a single line of code on the command-line.... Read more
EtreCheck Pro 6.0.2 - For troubleshootin...
EtreCheck is an app that displays the important details of your system configuration and allow you to copy that information to the Clipboard. It is meant to be used with Apple Support Communities to... Read more

Latest Forum Discussions

See All

TEPPEN guide - Tips and tricks for new p...
TEPPEN is a wild game that nobody asked for, but I’m sure glad it exists. Who would’ve thought that a CCG featuring Capcom characters could be so cool and weird? In case you’re not completely sure what TEPPEN is, make sure to check out our review... | Read more »
Dr. Mario World guide - Other games that...
We now live in a post-Dr. Mario World world, and I gotta say, things don’t feel too different. Nintendo continues to squirt out bad games on phones, causing all but the most stalwart fans of mobile games to question why they even bother... | Read more »
Strategy RPG Brown Dust introduces its b...
Epic turn-based RPG Brown Dust is set to turn 500 days old next week, and to celebrate, Neowiz has just unveiled its biggest and most exciting update yet, offering a host of new rewards, increased gacha rates, and a brand new feature that will... | Read more »
Dr. Mario World is yet another disappoin...
As soon as I booted up Dr. Mario World, I knew I wasn’t going to have fun with it. Nintendo’s record on phones thus far has been pretty spotty, with things trending downward as of late. [Read more] | Read more »
Retro Space Shooter P.3 is now available...
Shoot-em-ups tend to be a dime a dozen on the App Store, but every so often you come across one gem that aims to shake up the genre in a unique way. Developer Devjgame’s P.3 is the latest game seeking to do so this, working as a love letter to the... | Read more »
Void Tyrant guide - Guildins guide
I’ve still been putting a lot of time into Void Tyrant since it officially released last week, and it’s surprising how much stuff there is to uncover in such a simple-looking game. Just toray, I finished spending my Guildins on all available... | Read more »
Tactical RPG Brown Dust celebrates the s...
Neowiz is set to celebrate the summer by launching a 2-month long festival in its smash-hit RPG Brown Dust. The event kicks off today, and it’s divided into 4 parts, each of which will last two weeks. Brown Dust is all about collecting, upgrading,... | Read more »
Flappy Royale is an incredibly clever ta...
I spent the better part of my weekend playing Flappy Royale. I didn’t necessarily want to. I just felt like I had to. It’s a hypnotic experience that’s way too easy to just keep playing. | Read more »
Void Tyrant guide - General tips and tri...
Void Tyrant is a card-based dungeon-crawler that doesn’t fit in the mold of other games in the genre. Between the Blackjack-style combat and strange gear system alone, you’re left to your own devices to figure out how best to use everything to your... | Read more »
Webzen’s latest RPG First Hero is offici...
You might be busy sending your hulking Dark Knight into the midst of battle in Webzen’s other recent release: the long-anticipated MU Origin 2. But for something a little different, the South Korean publisher has launched First Hero. Released today... | Read more »

Price Scanner via

Amazon drops prices, now offers clearance 13″...
Amazon has new dropped prices on clearance 13″ 2.3GHz Dual-Core non-Touch Bar MacBook Pros by $200 off Apple’s original MSRP, with prices now available starting at $1099. Shipping is free. Be sure to... Read more
2018 15″ MacBook Pros now on sale for $500 of...
Amazon has dropped prices on select clearance 2018 15″ 6-Core MacBook Pros to $500 off Apple’s original MSRP. Prices now start at $1899 shipped: – 2018 15″ 2.2GHz Touch Bar MacBook Pro Silver: $1899.... Read more
Price drop! Clearance 12″ 1.2GHz Silver MacBo...
Amazon has dropped their price on the recently-discontinued 12″ 1.2GHz Silver MacBook to $849.99 shipped. That’s $450 off Apple’s original MSRP for this model, and it’s the cheapest price available... Read more
Apple’s 21″ 3.0GHz 4K iMac drops to only $936...
Abt Electronics has dropped their price on clearance, previous-generation 21″ 3.0GHz 4K iMacs to only $936 shipped. That’s $363 off Apple’s original MSRP, and it’s the cheapest price we’ve seen so... Read more
Amazon’s Prime Day savings on Apple 11″ iPad...
Amazon has new 2018 Apple 11″ iPad Pros in stock today and on sale for up to $250 off Apple’s MSRP as part of their Prime Day sale (but Prime membership is NOT required for these savings). These are... Read more
Prime Day Apple iPhone deal: $100 off all iPh...
Boost Mobile is offering Apple’s new 2018 iPhone Xr, iPhone Xs, and Xs Max for $100 off MSRP. Their discount reduces the cost of an Xs to $899 for the 64GB models and $999 for the 64GB Xs Max. Price... Read more
Clearance 13″ 2.3GHz Dual-Core MacBook Pros a...
Focus Camera has clearance 2017 13″ 2.3GHz/128GB non-Touch Bar Dual-Core MacBook Pros on sale for $169 off Apple’s original MSRP. Shipping is free. Focus charges sales tax for NY & NJ residents... Read more
Amazon Prime Day deal: 9.7″ Apple iPads for $...
Amazon is offering new 9.7″ WiFi iPads with Apple Pencil support for $80-$100 off MSRP as part of their Prime Day sale, starting at only $249. These are the same iPads found in Apple’s retail and... Read more
Amazon Prime Day deal: 10% (up to $20) off Ap...
Amazon is offering discounts on new 2019 Apple AirPods ranging up to $20 (10%) off MSRP as part of their Prime Day sales. Shipping is free: – AirPods with Charging Case: $144.99 $15 off MSRP –... Read more
Amazon Prime Day deal: $50-$80 off Apple Watc...
Amazon has Apple Watch Series 4 and Series 3 models on sale for $50-$80 off Apple’s MSRP as part of their Prime Day deals with prices starting at only $199. Choose Amazon as the seller rather than a... Read more

Jobs Board

*Apple* Graders/Inspectors (Seasonal/Hourly/...
…requirements. #COVAentryleveljobs ## Minimum Qualifications Some knowledge of agricultural and/or the apple industry is helpful as well as the ability to comprehend, Read more
Best Buy *Apple* Computing Master - Best Bu...
**710003BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Store Associates **Location Number:** 000171-Winchester Road-Store **Job Description:** Read more
Best Buy *Apple* Computing Master - Best Bu...
**709786BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Sales **Location Number:** 000430-Orange Park-Store **Job Description:** **What does a Read more
Geek Squad *Apple* Master Consultation Agen...
**709918BR** **Job Title:** Geek Squad Apple Master Consultation Agent **Job Category:** Services/Installation/Repair **Location Number:** 000106-Palmdale-Store Read more
*Apple* Systems Architect/Engineer, Vice Pre...
…its vision to be the world's most trusted financial group. **Summary:** Apple Systems Architect/Engineer with strong knowledge of products and services related to Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.