TweetFollow Us on Twitter

Sprocket Linked List 2
Volume Number:11
Issue Number:3
Column Tag:Getting Started

Adding Your Own Class to Sprocket, Part 2

Where to hook in with a linked list class...

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 created and tested a pair of classes that implemented a doubly linked list. This month we’ll look at the process of adding the linked list classes to a Sprocket project. Our goal is to create a linked list when the application starts up, then add a link to the list every time a new document is created. Each link in the list would contain a pointer to a TDocument object. When a document is closed, its corresponding link is removed from the list. When the application shuts down, the list is deleted.

Pre-Flighting Sprocket

Before you add new code to Sprocket, your first job is to make sure you have the latest version of Sprocket, and that you can get it to compile. As you no doubt have discovered for yourself, Macintosh development environments have an unsettling habit of changing with each new release, breaking your code in the process. The biggest reason for this is that Apple continuously updates their interface files, sending a constant stream of updates to the various compiler vendors. As of this writing, the latest version of Sprocket was built to run with a pre-release version of Code Warrior version CW5, which includes a slew of new headers. Though you can get the new version of Sprocket to compile using older versions of CodeWarrior, it will take a fair amount of work. Unfortunately, it would be impossible to continue to update Sprocket and to maintain compatibility with older versions of the various development environments. If you have any ideas about how we should be handling this problem, please send them along to our illustrious editor Scott (you can reach him at editorial@xplain.com).

As we go to press, Symantec had not yet released a version of Symantec C++ with the new Universal Headers, though by the time you read this, they likely will have. Since I can’t compile Sprocket using Symantec C++, all the figures in this month’s column are based on CodeWarrior. Hopefully, Symantec will make the new headers available in time for next month’s column.

When you go to any of the standard MacTech sites to download Sprocket
(see p. 2), there are two archives you’ll need. One should be called something like “Sprocket.12-15-94.sit” and the other something like “SprocketSample.12-15-94.sit”. The date in the middle is the date the archive was created, and should be about three months earlier than the date this article appears. The Sprocket archive contains the files that make up the Sprocket framework. The SprocketSample archive contains a few additional source code files, as well as a project file that brings the Sprocket and SprocketSample source together. The idea here is that Dave Falkenburg maintains Sprocket, while I maintain SprocketSample. Sprocket is a framework, while SprocketSample is an application that brings the framework to life. [You’ll be able to find the 12-15-94 versions, as well as any more recent releases at the online sites - ed stb]

Create a Sprocket folder on your hard drive, download and decompress the two archives, and copy each of the new folders into the Sprocket folder. Be sure each of the two folders has a date. This will distinguish the current Sprocket and SprocketSample folders from the versions you’ll download in following months. Figure 1 shows my master Sprocket folder. It contains one subfolder with the current version of Sprocket and another with two different versions of SprocketSample. The “before” folder contains all the SprocketSample code before I added in the list classes. The “after” folder contains the same program, this time with the list classes integrated in. We’ll start by getting the “before” version of SprocketSample to compile. Next, we’ll go through the process of converting the “before” version to the “after” version, then compile and run the “after” version.

Figure 1. My master Sprocket folder,
showing the folders for Sprocket and for SprocketSample.

Compiling the “Before” Version of SprocketSample

Each SprocketSample project is divided into two parts. The first part (the upper half of the project window) contains references to SprocketSample source code, while the second part (the lower half of the project window) contains references to Sprocket source code (Figure 2).

Figure 2. The 68K CodeWarrior version of the SprocketSample project.

To get the code in your SprocketSample project to compile, you’ve got to make sure the compiler can find all of the project’s files. If you are using CodeWarrior, launch either the PowerPC or 68K project, select Preferences... from the Edit menu, then scroll down to and click on the Access Paths icon (Figure 3). The rectangle labeled User: shows the paths that will be searched for source code files. The rectangle labeled System: shows the paths that will be searched for things like system include files. You want to make sure that the User: rectangle contains one additional path besides that leading to the project folder. The additional path is the folder containing the Sprocket source code. If this second path is there, but is wrong, click on it and press the Change button, then navigate into and select the folder containing the Sprocket source code. If the second path is there and looks good, just leave it alone. If there is no second path, click on the Add button and select the folder containing the Sprocket source code.

Figure 3. The CodeWarrior Access Paths preferences panel.

The point is, you want to make sure the compiler can find the Sprocket source code as well as the SprocketSample source. You know that the compiler will find the SprocketSample source code since it is in a subfolder inside the project folder. Once your new folder appears in the User: rectangle, click the OK button to save your preferences.

Next, you’ll need to make sure that your CodeWarrior project includes the proper precompiled header file. If you look at the project window shown in Figure 2, the very first file in the project is named SprocketSampleHeaders68K.pch++. This file is a source code file which will be precompiled, then used to compile all the other source files in the project. By precompiling all the #includes and #defines used by all your source code files, you can significantly reduce your compile times.

When CodeWarrior encounters a project file that ends in “.pch++”, it compiles the file into a precompiled header, saving the header in the same folder as its corresponding “.pch++” file. Select Preferences... from the Edit menu, then scroll down to the Language preferences. The Prefix File field tells the compiler which precompiled header to use when it compiles the project source code files (Figure 4). Make sure that the field contains either SprocketSampleHeaders68K or SprocketSampleHeadersPPC, making sure it matches the “.pch++” file in your project.

Figure 4. CodeWarrior’s Language preferences panel.

If you are using Symantec C++, you’ll have to address these same issues and get hold of the latest Universal Headers. That’s about it. You are now ready to take the “before” version of SprocketSample for a spin. Once you get everything to compile, you’ll see the familiar splash screen, menu bar, and empty tool palette window. Once you’ve had a chance to play with SprocketSample for a bit, quit and let’s add our list classes into the mix.

Adding the List Classes

Just as a reminder, here are the two linked list class definitions. TLinkedList is the linked list itself and TLink is a single link:

class    TLinkedList
{
  public:
                            TLinkedList();
    virtual                 ~TLinkedList();

    virtual    OSErr        CreateAndAddLink( void *objectPtr );
    virtual    OSErr        FindAndDeleteLink( void *objectPtr );
    virtual unsigned long   CountLinks();
    virtual void            *GetNthLinkObject( unsigned long 
                                                 linkIndex );

  protected:
    virtual void            DeleteAllLinks();
    TLink                   *FindLink( void *objectPtr );
    virtual OSErr           DeleteLink( TLink *linkPtr );
    
    TLink                   *fFirstLinkPtr;
    TLink                   *fLastLinkPtr;
};

class    TLink
{
  public:
                    TLink( void *objectPtr );
    virtual         ~TLink();
    virtual void    SetPrevLink( TLink *prevLinkPtr )
                        { fPrevLinkPtr = prevLinkPtr; }
    virtual void    SetNextLink( TLink *nextLinkPtr )
                        { fNextLinkPtr = nextLinkPtr; }
    virtual TLink   *GetPrevLink()
                        { return fPrevLinkPtr; }
    virtual TLink   *GetNextLink()
                        { return fNextLinkPtr; }
    virtual void    *GetObjectPtr()
                        { return fObjectPtr; }

  protected:
      TLink         *fPrevLinkPtr;
      TLink         *fNextLinkPtr;
      void          *fObjectPtr;
};

The first thing you’ll need to do is copy the four source code files that make up the TLinkedList and TLink classes into the same folder as the SprocketSample source code. In this case, you’ll copy the files LinkedList.cp, LinkedList.h, Link.cp, and Link.h into the SprocketSample folder located inside the folder named SprocketSample, Before. Be sure to add Link.cp and LinkedList.cp to the first half of the project window.

Next, you’ll need to modify SetUpApplication() to create a new TLinkedList object and QuitApplication() to step through the list and close all the documents stored in the list. You’ll also need to create a global variable containing a pointer to the TLinkedList object. To do that, create a file called SprocketSample.h and type in the following code:

#include "LinkedList.h"

extern  TLinkedList*gListPtr;

Save SprocketSample.h in the same folder as all the other SprocketSample source code.

Next, open the file SprocketSample.cp and add these two lines at the top:

#include "SprocketSample.h"

TLinkedList *gListPtr;

Now scroll down to the first routine in SprocketSample.cp, which should be SetupApplication(). Here’s where you’ll create a new TLinkedList object. Add this line at the beginning of SetupApplication():

gListPtr = new TLinkedList;

Scroll down about 4/5 of the way down in SprocketSample.cp and find the routine QuitApplication(). Change the routine so it reads like this:

Boolean QuitApplication(void)
{
 unsigned long numLinks, counter;
 TDocWindow *myDocPtr;
 OSErr  err;
 
 numLinks = gListPtr->CountLinks();
 for ( counter=1; counter<=numLinks; counter++ )
 {
 myDocPtr = (TDocWindow *)gListPtr->GetNthLinkObject( 1 );
// If the user cancels the close, return false to cancel the quit...
 if ( ! myDocPtr->Close() )
 return false;
 else
 delete myDocPtr;
 }
 
 return true;
}

The main purpose of QuitApplication() is to step through the list of documents, sending each document object a close message. If a document has changed since it was last saved, its close method will give the user a chance to cancel the close. If the close is canceled, we’ll exit the loop by returning false, thus canceling the quit. If the user doesn’t cancel a close, the TDocWindow object under consideration is deleted.

A few things worth noting here. Notice that we delete the TDocWindow but don’t remove it from the list first. That is done in the TDocWindow destructor. Deleting it from the list inside the TDocWindow destructor has two advantages. First, this keeps us from having to remember to delete the TLink every time we delete a TDocWindow. Secondly, this ties the deletion of the link as closely as possible to the actual deletion of the TDocWindow, keeping us from the nasty situation where we have a TDocWindow that isn’t in the list or where we have a TLink that points to a TDocWindow that’s already been deleted.

Take some time to look through the code that closes documents. Look in SprocketMain.cp at the code that handles clicks in a window’s close box and at the code that handles the Close and Quit menu items. Also check out the code that responds to the quit application Apple event. This code will probably change slightly in the future, but it won’t change by much. The most likely change is to merge all the above-mentioned code so that it all closes documents the exact same way.

Our final task is to modify the TDocWindow constructor and destructor. The constructor needs to embed a pointer to the new TDocWindow in a TLink, adding the TLink to the list pointed to by gListPtr. The destructor needs to find the TLink containing the TDocWindow about to be destroyed, and remove that link from the list.

Before you edit the constructor and destructor, you’ll need to add this line to the beginning of DocWindow.cp:

#include "SprocketSample.h"

This will give you access to the global gListPtr as well as to the TLinkedList class.

Now add these three lines to the end of the TDocWindow() constructor:

 err = gListPtr->CreateAndAddLink( this );
 if ( err != noErr )
 DebugStr((StringPtr) "\pAdd Doc to list failed");

The first line adds a pointer to the current object to the list, while the second two lines drop us into MacsBug if the add failed.

Add these three lines to the ~TDocWindow() destructor:

 err = gListPtr->FindAndDeleteLink( this );
 if (err != noErr)
 DebugStr((StringPtr) "\Delete doc from list failed");

The first line deletes the TDocWindow from the global linked list. The second two lines drop us into MacsBug if the delete fails.

Running the New, Improved SprocketSample

OK, now that all your changes are in, run your new version of SprocketSample (or, if you just can’t wait long enough to type in the changes, run the version of SprocketSample in the SprocketSample, After folder). Select New from the File menu and create 3 new documents. Next, click in the close box of the frontmost window. You’ll be prompted to save the changes in that window. Click the Save button.

Now select Quit from the File menu. Once again, you’ll be prompted to save changes in a document, but this time you’ll be prompted to save the changes in the first document in the global TLinkedList, which should be the document named “Untitled-1”. If you click the cancel button, the quit should be aborted and you should be left running as you were before you selected Quit.

Experiment with various cancel and saving combinations. Try sending a quit application Apple event to SprocketSample by launching this script from the Script Editor:

tell application "SprocketSample.68K"
 quit
end tell

Be sure to change the name of the application in the tell clause if you are not running with the 68K version of CodeWarrior. Use the debugger to follow the code. Though Sprocket might seem a little intimidating, it’s really not that hard to follow once you get into it, especially if you confine yourself to a specific functional area or thread.

Until Next Month

In next month’s column, we’ll look into Sprocket’s menu handling model and add our own menus to Sprocket’s menu bar. The current plan is to replace the existing menu-processing code with a new design that more closely approximates that used by OpenDoc. The idea is, if you learn how to handle menus in Sprocket, you’ll have a leg up when you start writing your first OpenDoc part.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Postbox 5.0.9 - Powerful and flexible em...
Postbox is a new email application that helps you organize your work life and get stuff done. It has all the elegance and simplicity of Apple Mail, but with more power and flexibility to manage even... Read more
VueScan 9.5.61 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
DiskCatalogMaker 6.5.16 - Catalog your d...
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... Read more
TrailRunner 3.8.827 - Route planning for...
TrailRunner is the perfect companion for runners, bikers, hikers, and all people wandering under the sky. Plan routes on a geographical map. Import GPS or workout recordings and journalize your... Read more
Civilization VI 1.0.1 - Next iteration o...
Sid Meier’s Civilization VI is the next entry in the popular Civilization franchise. Originally created by legendary game designer Sid Meier, Civilization is a strategy game in which you attempt to... Read more
Chromium 55.0.2883.75 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. Version 55.0.2883.75: Security fixes: High CVE-2016... Read more
Google Chrome 55.0.2883.75 - 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
VirtualBox 5.1.10 - x86 virtualization s...
VirtualBox is a family of powerful x86 virtualization products for enterprise as well as home use. Not only is VirtualBox an extremely feature rich, high performance product for enterprise customers... Read more
Pixa 1.1.9 - Quickly and easily organize...
Pixa is an image-organizing application. The new app functions well, is easy to use, and helps people organize their images quickly and easily on their computers. For those who prefer not to use the... Read more
VirtualBox 5.1.10 - x86 virtualization s...
VirtualBox is a family of powerful x86 virtualization products for enterprise as well as home use. Not only is VirtualBox an extremely feature rich, high performance product for enterprise customers... Read more

Latest Forum Discussions

See All

Amateur Surgeon 4 Guide: Become the worl...
It's time to wield your trusty pizza cutter again, as Amateur Surgeon has returned with a whole fresh set of challenges (and some old, familiar ones, too). Starting anew isn't easy, especially when all you have at your disposal is a lighter, the... | Read more »
Le Parker: Sous Chef Extraordinaire (Ga...
Le Parker: Sous Chef Extraordinaire 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »
Telltale Games really is working on a Gu...
Telltale Games' next episodic adventure is indeed Guardians of the Galaxy. A document tied to the voice actors strike suggested that the project was in the work, but now we have direct confirmation following an announcement at the Game Awards that... | Read more »
Amateur Surgeon returns to iOS and Andro...
Amateur Surgeon and its two sequels disappeared from the App Store some time and it was sad days for all. But now, just in time for the holidays, the Adult Swim favorite makes its joyous return in the shape of Amateur Surgeon 4, a remake with... | Read more »
The best board games on mobile
Sometimes you need to ditch all of the high speed, high action games in favor of something a little more traditional. If you don't feel like parting ways from your mobile device, though, there are still plenty of ways to get that old-school fix.... | Read more »
The best Facebook Messenger Instant Game...
Facebook's new Instant Games is now here, meaning you can play games with your friends directly via Facebook. It's a fun new way to connect with friends, of course, but it's also proving to be a solid gaming experience in its own right, with a... | Read more »
You can now play game's on Facebook...
Facebook launched its new Instant Games platform in an exciting new attempt to engage its user base. As a result, you can now play a number of different games directly through Facebook Messenger. All of these games run with HTML5, meaning you play... | Read more »
Apollo Justice Ace Attorney (Games)
Apollo Justice Ace Attorney 1.00.00 Device: iOS Universal Category: Games Price: $.99, Version: 1.00.00 (iTunes) Description: Court Is Back In Session Star as rookie defense attorney, Apollo Justice, as he visits crime scenes,... | Read more »
KORG iWAVESTATION (Music)
KORG iWAVESTATION 1.0 Device: iOS Universal Category: Music Price: $19.99, Version: 1.0 (iTunes) Description: A revolutionary new world of sound.The Wave Sequence Synthesizer for iPad - KORG iWAVESTATION | Read more »
Don't Grind Guide: Tips for becomin...
Don’t Grind is a surprising, derpy little one touch game with fun hand-drawn graphics. The goal is simple -- get the high score without being chopped to bits. That can be tough when you’re not used to the game, and that’s compounded by the fact... | Read more »

Price Scanner via MacPrices.net

Holiday sale: Apple MacBook Airs available fo...
B&H Photo has 13″ MacBook Airs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 1.6GHz/128GB MacBook Air (MMGF2LL/A): $899 $100 off MSRP - 13″ 1.6GHz/... Read more
13-inch Silver Touch Bar MacBook Pro in stock...
Amazon has the new 2016 13″ 2.9GHz/256GB Silver Touch Bar MacBook Pro (MLVP2LL/A) in stock today and on sale for $1749 including free shipping. That’s $50 off MSRP, and it’s the lowest price... Read more
Parallels Toolbox 1.3 for Mac Offers 25 Singl...
Parallels has launched Parallels Toolbox 1.3 for Mac, an upgrade that adds five new utilities to the stand-alone application which was released in August and is available exclusively online at http... Read more
OWC Mercury Elite Pro Dual mini Ultra-Portabl...
OWC has introduced the new OWC Mercury Elite Pro Dual mini, a powerful yet ultra-portable dual-drive RAID solution. The new Mercury Elite Pro Dual mini packs phenomenal performance into a small... Read more
Clearance 13-inch Retina MacBook Pros availab...
B&H Photo has clearance 2015 13″ Retina Apple MacBook Pros available for up to $200 off original MSRP. Shipping is free, and B&H charges NY tax only: - 13″ 2.7GHz/128GB Retina MacBook Pro: $... Read more
Roundup of 2016 13-inch 2.0GHz MacBook Pro sa...
B&H has the non-Touch Bar 13″ MacBook Pros in stock today for $50-$100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.0GHz MacBook Pro Space Gray (MLL42LL/A): $1449 $... Read more
New 13-inch 2.0GHz Space Gray MacBook Pro in...
Adorama has the new 13″ 2.0GHz Space Gray MacBook Pro (non-Touch Bar, MLL42LL/A) in stock for $1499 including a free 3-year AppleCare Protection Plan. Shipping is free, and Adorama charges sales tax... Read more
Finnair Adopts iOS Enterprise iPad Apps from...
Finnair and IBM have announced a first-of-its-kind agreement to utilize iOS enterprise apps from IBM to support the airline’s overall digital transformation. Finnair is focused on Asia-Europe traffic... Read more
Tech21 Launches Evo Go iPhone 7 Case Availabl...
Tech21 has announced the launch of the Evo Go case for Apple iPhone 7 and iPhone 7 Plus, exclusively at T-Mobile. Available online and at participating T-Mobile stores nationwide, Evo Go cases start... Read more
Apple Turns (RED) with More Ways to Join the...
In recognition of World AIDS Day, Apple is offering more ways than ever for customers to join (RED) in its mission to create an AIDS-free generation. Apple is the worlds largest corporate contributor... Read more

Jobs Board

*Apple* Retail - Multiple Positions- Chicago...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Hardware Design Validation Engineer - *Apple...
The Apple Watch team is looking for a Hardware Design Validation Engineer. This person will be part of the Apple Watch hardware team with responsibilities for Read more
SW Engineer *Apple* TV Frameworks - Apple I...
The Apple TV team is looking for a software...create features that reflect the look and feel of Apple TV. Description: Were looking for someone who is Read more
*Apple* Retail - Multiple Positions- Greenwi...
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* Brand Ambassador (Macy's) - The...
…(T-ROC), is proud of its unprecedented relationship with our partner and client, APPLE ,in bringing amazing" APPLE ADVOCATES"to "non" Apple store locations. Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.