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

TunnelBear 3.0.1 - Subscription-based pr...
TunnelBear is a subscription-based virtual private network (VPN) service and companion app, enabling you to browse the internet privately and securely. Features Browse privately - Secure your data... Read more
ExpanDrive 5.4.0 - Access cloud storage...
ExpanDrive builds cloud storage in every application, acts just like a USB drive plugged into your Mac. With ExpanDrive, you can securely access any remote file server directly from the Finder or... Read more
Opera 40.0.2308.62 - High-performance We...
Opera is a fast and secure browser trusted by millions of users. With the intuitive interface, Speed Dial and visual bookmarks for organizing favorite sites, news feature with fresh, relevant content... Read more
Apple iOS 10.0.2 - The latest version of...
iOS 10 is the biggest release of iOS ever. A massive update to Messages brings the power of the App Store to your conversations and makes messaging more personal than ever. Find your route with... Read more
Herald 7.0 - Notification plugin for Mai...
Note: Versions 2.1.3 (for OS X 10.7), 3.0.6 (for OS X 10.8), 4.0.8 (for OS X 10.9), 5.0.2 (for OS X 10.10), and 6.0.3 (for OS X 10.11) are no longer supported by the developer. Herald is a... Read more
Postbox 5.0.2 - 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
Yummy FTP Pro 1.11.10 - $29.99
Yummy FTP Pro is an advanced Mac file transfer app which provides a full-featured professional toolkit combined with blazing speeds and impeccable reliability, so whether you want to transfer a few... Read more
Tidy Up 4.1.17 - $29.99
Tidy Up is a full-featured duplicate finder and disk-tidiness utility. Features With Tidy Up you can search for duplicate files and packages by the owner application, content, type, creator,... Read more
Logitech Control Center 3.9.5 - Keyboard...
Logitech Control Center (LCC) is designed to support OS X and allows you to take full advantage of your Logitech keyboard, mouse, or trackball. With the LCC you can: Browse the Internet using... Read more
Macgo Blu-ray Player 2.16.17 - Blu-ray p...
Macgo Blu-ray Player can bring you the most unforgettable Blu-ray experience on your Mac. Overview Macgo Mac Blu-ray Player can satisfy just about every need you could possibly have in a Blu-ray... Read more

How to build and care for your team in D...
Before you hit the trail and become a dog sledding legend, there’s actually a fair bit of prep work to be done. In Dog Sled Saga, you’re not only racing, you’re also building and caring for a team of furry friends. There’s a lot to consider—... | Read more »
How to win every race in Dog Sled Saga
If I had to guess, I’d say Dog Sled Saga is the most adorable racing game on the App Store right now. It’s a dog sled racing sim full of adorable, loyal puppies. Just look at those fluffy little tails wagging. Behind that cute, pixelated facade is... | Read more »
Let the war games commence in Gunship Ba...
Buzz Lightyear famously said, “This isn’t flying, this is falling – with style!” In the case of Gunship Battle: Second War, though, this really is flying - with style! The flight simulator app from Joycity puts you in control of 20 faithfully... | Read more »
How to get a high score in Fired Up
Fired Up is Noodlecake Games’ high score chasing, firefighting adventure. You take control of a wayward firefighter who propels himself up the side of a highrise with blasts of water. Sound silly? It is. It’s also pretty difficult. You can’t... | Read more »
NBA 2K17 (Games)
NBA 2K17 1.0 Device: iOS iPhone Category: Games Price: $7.99, Version: 1.0 (iTunes) Description: Following the record-breaking launch of NBA 2K16, the NBA 2K franchise continues to stake its claim as the most authentic sports video... | Read more »
Dog Sled Saga (Games)
Dog Sled Saga 1.0.1 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0.1 (iTunes) Description: A game by Dan + Lisa As a rookie musher, foster a dogsledding team whose skills will grow if they're treated right. Week by... | Read more »
60 Seconds! Atomic Adventure (Games)
60 Seconds! Atomic Adventure 1.2 Device: iOS Universal Category: Games Price: $2.99, Version: 1.2 (iTunes) Description: 60 Seconds! is a dark comedy atomic adventure of scavenge and survival. Collect supplies and rescue your family... | Read more »
Tons of Bullets! (Games)
Tons of Bullets! 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Tons of BulletsA retro 2D pixel platformer infused with tons of bullets and tons of features!Fight as Kenji the Ninja and... | Read more »
Sorcery! 4 (Games)
Sorcery! 4 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: *** PLEASE NOTE: Sorcery! 4 requires a minimum of iPad 3 or iPhone 4 *** An epic adventure through a cursed citadel of monsters,... | Read more »
Building the perfect Animation Throwdown...
Animation Throwdown is a casual card game full of plenty of inside jokes from some of your favorite cartoons. It’s accessible as far as card games go, but that’s not to say that it hands your victories to you easily. There’s quite a bit that goes... | Read more »

Price Scanner via MacPrices.net

Duplicate Sweeper Free On Mac App Store For O...
To celebrate the launch of Apple’s latest macOS Sierra, Stafford, United Kingdom based Wide Angle Software has announced that its duplicate file finder software, Duplicate Sweeper, is now available... Read more
13-inch Retina MacBook Pros on sale for up to...
B&H Photo has 13″ Retina Apple MacBook Pros on sale for up to $150 off MSRP. Shipping is free, and B&H charges NY tax only: - 13″ 2.7GHz/128GB Retina MacBook Pro: $1174.99 $125 off MSRP - 13... Read more
Evidence Surfaces Pointing To New A10X Chip F...
Citing a job description for a Project Lead position at Apple’s Austin, Texas engineering labs, Motley Fool’s Ashraf Eassa deduces that development is progressing well on Apple’s next-generation in-... Read more
Check Print’R for macOS Allows Anyone to Easi...
Delaware-based Match Software has announced the release and immediate availability of Check Print’R 3.21, an important update to their easy-to-use check printing application for macOS. Check Print’R... Read more
Apple refurbished 11-inch MacBook Airs availa...
Apple has Certified Refurbished 11″ MacBook Airs (the latest models), available for up to $170 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is... Read more
Apple refurbished 15-inch Retina MacBook Pros...
Apple has Certified Refurbished 2015 15″ Retina MacBook Pros available for up to $380 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: - 15″ 2... Read more
Major Version 5 Release Of Free myTuner Radio...
AppGeneration Software has announced the release of myTuner Radio 5.0.1, an important update to their live radio app for iOS and Android platforms. With myTuner Radio, you can listen to more than 30,... Read more
TheAppStore Searches And Filters iOS And macO...
Boston based InchWest has announced the official launch of TheAppStore, a free web based service that lets users search iOS and Mac apps on the web without iTunes or the App store. TheAppStore... Read more
2TB Time Capsule on sale for $199, save $100
Amazon has 2TB Apple Time Capsules on sale for $199 including free shipping. Their price is $100 off MSRP. Choose Amazon as the seller when making your purchase, rather than a third party seller. Read more
12-inch 1.2GHz Rose Gold Retina MacBook on sa...
Amazon.com has the 2016 12″ 1.2GHz Rose Gold Retina MacBook on sale for $1254.02 including free shipping. Their price is $345 off MSRP, and it’s the lowest price available for this model from any... Read more

Jobs Board

Senior *Apple* Administrator - Pratt Instit...
POSITION SUMMARY: Directs the coordination and standardization of campus-wide Apple systems, including planning, analysis and implementation of Apple -related Read more
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
*Apple* Retail - Multiple Positions- Napervi...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
US- *Apple* Store Leader Program - Apple (Un...
…Summary Learn and grow as you explore the art of leadership at the Apple Store. You'll master our retail business inside and out through training, hands-on 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.