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

Latest Forum Discussions

See All

Pack a magnifying glass and practice you...
Somehow it has already been a year since Torchlight: Infinite launched, and XD Games is celebrating by blending in what sounds like a truly fantastic new update. Fans of Cthulhu rejoice, as Whispering Mist brings some horror elements, and tests... | Read more »
Summon your guild and prepare for war in...
Netmarble is making some pretty big moves with their latest update for Seven Knights Idle Adventure, with a bunch of interesting additions. Two new heroes enter the battle, there are events and bosses abound, and perhaps most interesting, a huge... | Read more »
Make the passage of time your plaything...
While some of us are still waiting for a chance to get our hands on Ash Prime - yes, don’t remind me I could currently buy him this month I’m barely hanging on - Digital Extremes has announced its next anticipated Prime Form for Warframe. Starting... | Read more »
If you can find it and fit through the d...
The holy trinity of amazing company names have come together, to release their equally amazing and adorable mobile game, Hamster Inn. Published by HyperBeard Games, and co-developed by Mum Not Proud and Little Sasquatch Studios, it's time to... | Read more »
Amikin Survival opens for pre-orders on...
Join me on the wonderful trip down the inspiration rabbit hole; much as Palworld seemingly “borrowed” many aspects from the hit Pokemon franchise, it is time for the heavily armed animal survival to also spawn some illegitimate children as Helio... | Read more »
PUBG Mobile teams up with global phenome...
Since launching in 2019, SpyxFamily has exploded to damn near catastrophic popularity, so it was only a matter of time before a mobile game snapped up a collaboration. Enter PUBG Mobile. Until May 12th, players will be able to collect a host of... | Read more »
Embark into the frozen tundra of certain...
Chucklefish, developers of hit action-adventure sandbox game Starbound and owner of one of the cutest logos in gaming, has released their roguelike deck-builder Wildfrost. Created alongside developers Gaziter and Deadpan Games, Wildfrost will... | Read more »
MoreFun Studios has announced Season 4,...
Tension has escalated in the ever-volatile world of Arena Breakout, as your old pal Randall Fisher and bosses Fred and Perrero continue to lob insults and explosives at each other, bringing us to a new phase of warfare. Season 4, Into The Fog of... | Read more »
Top Mobile Game Discounts
Every day, we pick out a curated list of the best mobile discounts on the App Store and post them here. This list won't be comprehensive, but it every game on it is recommended. Feel free to check out the coverage we did on them in the links below... | Read more »
Marvel Future Fight celebrates nine year...
Announced alongside an advertising image I can only assume was aimed squarely at myself with the prominent Deadpool and Odin featured on it, Netmarble has revealed their celebrations for the 9th anniversary of Marvel Future Fight. The Countdown... | Read more »

Price Scanner via MacPrices.net

Every model of Apple’s 13-inch M3 MacBook Air...
Best Buy has Apple 13″ MacBook Airs with M3 CPUs in stock and on sale today for $100 off MSRP. Prices start at $999. Their prices are the lowest currently available for new 13″ M3 MacBook Airs among... Read more
Sunday Sale: Apple iPad Magic Keyboards for 1...
Walmart has Apple Magic Keyboards for 12.9″ iPad Pros, in Black, on sale for $150 off MSRP on their online store. Sale price for online orders only, in-store price may vary. Order online and choose... Read more
Apple Watch Ultra 2 now available at Apple fo...
Apple has, for the first time, begun offering Certified Refurbished Apple Watch Ultra 2 models in their online store for $679, or $120 off MSRP. Each Watch includes Apple’s standard one-year warranty... Read more
AT&T has the iPhone 14 on sale for only $...
AT&T has the 128GB Apple iPhone 14 available for only $5.99 per month for new and existing customers when you activate unlimited service and use AT&T’s 36 month installment plan. The fine... Read more
Amazon is offering a $100 discount on every M...
Amazon is offering a $100 instant discount on each configuration of Apple’s new 13″ M3 MacBook Air, in Midnight, this weekend. These are the lowest prices currently available for new 13″ M3 MacBook... Read more
You can save $300-$480 on a 14-inch M3 Pro/Ma...
Apple has 14″ M3 Pro and M3 Max MacBook Pros in stock today and available, Certified Refurbished, starting at $1699 and ranging up to $480 off MSRP. Each model features a new outer case, shipping is... Read more
24-inch M1 iMacs available at Apple starting...
Apple has clearance M1 iMacs available in their Certified Refurbished store starting at $1049 and ranging up to $300 off original MSRP. Each iMac is in like-new condition and comes with Apple’s... Read more
Walmart continues to offer $699 13-inch M1 Ma...
Walmart continues to offer new Apple 13″ M1 MacBook Airs (8GB RAM, 256GB SSD) online for $699, $300 off original MSRP, in Space Gray, Silver, and Gold colors. These are new MacBook for sale by... Read more
B&H has 13-inch M2 MacBook Airs with 16GB...
B&H Photo has 13″ MacBook Airs with M2 CPUs, 16GB of memory, and 256GB of storage in stock and on sale for $1099, $100 off Apple’s MSRP for this configuration. Free 1-2 day delivery is available... Read more
14-inch M3 MacBook Pro with 16GB of RAM avail...
Apple has the 14″ M3 MacBook Pro with 16GB of RAM and 1TB of storage, Certified Refurbished, available for $300 off MSRP. Each MacBook Pro features a new outer case, shipping is free, and an Apple 1-... Read more

Jobs Board

*Apple* Systems Administrator - JAMF - Activ...
…**Public Trust/Other Required:** None **Job Family:** Systems Administration **Skills:** Apple Platforms,Computer Servers,Jamf Pro **Experience:** 3 + years of Read more
IT Systems Engineer ( *Apple* Platforms) - S...
IT Systems Engineer ( Apple Platforms) at SpaceX Hawthorne, CA SpaceX was founded under the belief that a future where humanity is out exploring the stars is Read more
Nurse Anesthetist - *Apple* Hill Surgery Ce...
Nurse Anesthetist - Apple Hill Surgery Center Location: WellSpan Medical Group, York, PA Schedule: Full Time Sign-On Bonus Eligible Remote/Hybrid Regular Apply Now Read more
Housekeeper, *Apple* Valley Village - Cassi...
Apple Valley Village Health Care Center, a senior care campus, is hiring a Part-Time Housekeeper to join our team! We will train you for this position! In this role, Read more
Sublease Associate Optometrist- *Apple* Val...
Sublease Associate Optometrist- Apple Valley, CA- Target Optical Date: Apr 20, 2024 Brand: Target Optical Location: Apple Valley, CA, US, 92307 **Requisition Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.