TweetFollow Us on Twitter

Sprocket is Here
Volume Number:11
Issue Number:1
Column Tag:Getting Started

Sprocket is Here!

Getting started requires getting in to gear!

By Dave Mark, MacTech Magazine Regular Contributing Author

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

In the last few columns, I told you about a new framework that was going to form the basis for much of the code written for this magazine. Well, as you can see from the title, Sprocket is here! Though Sprocket has existed in various incarnations for a while, I’ve only recently had the chance to really get into it. (I’ve been completely consumed with the goal of getting Ultimate Mac Programming out the door in time for January MacWorld).

This month, we’ll take a walk through the Sprocket architecture, focusing on the files and routines you’ll work with as you customize Sprocket to fit your needs.

Getting Sprocket

The first thing you’ll need to do is get a copy of the latest version of Sprocket. It’s included on the monthly MacTech source code disks and is archived at the usual online sites (which are listed every month on page 2).

Hopefully, by the time you read this, there will be versions of Sprocket for both Symantec C++ and Metrowerks CodeWarrior. As I write this, I’ve only got the CodeWarrior version, so bear with this unintended bias. Hopefully, there won’t be too many differences between the two versions.

As you get into Sprocket, it’s important to realize that we are at the beginning of a long evolutionary process. Sprocket was just born and there will no doubt be lots of design changes, bugs, and what have you. Here’s your chance to get in on the ground floor. If you find a bug, or have any specific comments about or feature requests for Sprocket, send a complete description to sprocket@hax.com.

The Sprocket Files

Open the Sprocket folder and launch the Sprocket project (mine was called SprocketSample.µ). You’ll notice that the files are organized into three different groups.

On the 680x0 side of the fence, each of these groups takes the form of a segment. On the PowerPC side, segments are a thing of the past, so the file groupings are more for aesthetics.

The first group of files is called Sprocket Code (see Figure 1), and is made up of the files that are private to Sprocket. These are the files that implement things like the event loop, the main base classes, the required Apple events, etc. For now, just ignore these files. As you get to know Sprocket and have a few Sprocket applications under your belt, you might want to explore these files and possibly tweak a few things to fit your specific needs.

The second group of files is labeled GX Graphics Libraries and contains routines you’ll need to work with Quickdraw GX. By the time you read this, the file(s) in this section may have been rolled in with the rest of the files in the Sprocket Code section.

The third group of files is labeled Application Specific. This is where you’ll put your code. As you’ll see, contained within the files in this section are a series of 9 routines that you must provide to make Sprocket run. These routines do things like perform application initialization, dispatch menu selections, and create new documents. Every Sprocket application has these routines, including the generic Sprocket application that came with Sprocket in the first place. Each time you create a new Sprocket application, you’ll duplicate the folder containing the application specific files, then edit the routines in those files as you see fit. At the very least, you’ll need to make sure that the 9 critical routines do what you need them to.

Figure 1. My Sprocket project file, as implemented by CodeWarrior.

A Quick Sprocket Test Drive

Before we get to them, let’s take Sprocket for a quick spin, just to get a feel for what it looks like. Once again, keep in mind the fact that I’m writing this in November and that things will undoubtedly change by the time you read this.

When you launch the generic Sprocket application, two new windows appear. The window on the left is a palette or tool window (Figure 2). It floats, meaning that it always appears in front of all other windows. Imagine this window filled with tool icons. When the user clicks on an icon, you’ll change the cursor to reflect the new tool and implement the tool’s behavior as the user clicks and drags in a document window.

Figure 2. The generic Sprocket tool window.

The other window that appears (Figure 3) is a document window, customized to include a nifty pair of spinning arrows in their own pane, a pair of horizontal lines that separate this pane from the main content region, and a pair of scroll bars. If you select New from the File menu, a new, untitled document window will appear. When you create your own sprocket applications, you’ll have complete control over the look and behavior of your document windows. Customizing the window (as Dave did with his spinning arrows) is up to you. Sprocket handles generic window behavior like clicks in a window’s close, grow, or zoom area. When drawing is necessary, Sprocket will call the window’s Draw() method, which you’ll override with your own Draw routine. You’ll see how to do that in next month’s column.

Figure 3. A generic Sprocket document window with the spinning cursors.

If you select Preferences... from the File menu, the preferences dialog in Figure 4 will appear. This will eventually evolve into a scrolling list of icons, each of which gives the user access to a different portion of the application preferences. Got any ideas for this dialog? Send ‘em in!

The Sprocket menu bar is pretty generic (appropriately so). It features standard File and Edit menus, as well as a not-so-standard Debug menu. If your Mac is AOCE aware (if you have PowerTalk installed, for example), the Debug menu will feature an an item that lets you create a new window with an AOCE mailer attached to it.

If you want to explore this topic further (we won’t get into it for a while) search for the flag qAOCEAware. If you won’t be supporting AOCE, you’ll want to turn this flag off, since it will save you considerably in code size.

Figure 4. The Sprocket generic preferences dialog as it appeared in November.

Let’s take a look at two of the files in the Application Specific group. The first of these files, AppSpecific.rsrc, holds the resources you want to add to Sprocket. The second file, App.cp, holds the nine routines that you’ll need to provide to customize Sprocket. We’ll get to the rest of the Application Specific files in next month’s column.

AppSpecific.rsrc

Sprocket divides its resources between two resource files. Sprocket.rsrc contains the resources that are private to Sprocket, while AppSpecific.rsrc contains the resources you’ll add to the project yourself. Take some time to look through the resources that come with the generic Sprocket project. As you look through AppSpecific.rsrc, you’ll notice that there are MENU resources for the Apple and Debug menus, but that there are no MENUs for the File and Edit menus. The File and Edit menus are defined in Sprocket.rsrc. Notice that the Debug menu is not included in the MBAR resource used by Sprocket (MBAR 128). The Debug menu was added by Sprocket using a call to InsertMenu() (Look in App.cp for the constant mDebug to follow this process). Take all this with a grain of salt, since it will most likely change in the near future. By the time you read this, a new version of Sprocket that gives you complete control over the menu bar will be released. The plan is that you will provide an MBAR resource and MENU resources to go along with the MENU ids listed in the MBAR resource. At this point, it’s not clear how the File and Edit menus will be handled. More on this as Sprocket evolves.

App.cp

This is the most important of your source code files. Here’s where the aforementioned 9 mandatory routines reside. As you get started, you’ll want to edit a copy of App.cp, using the existing 9 routines as the basis for your own code. Here’s the function prototypes for these 9 routines which you must supply (the prototypes are at the very bottom of <Sprocket.h>):

// initialization & tear down
extern  OSErr  SetupApplication(void);
extern  voidTearDownApplication(void);

// menu handling:
extern  voidHandleMenu(TWindow * topWindowObj,long menuCode);

// scrap coercion hooks:
extern  voidWriteLocalClipboardToScrap(void);
extern  voidReadLocalClipboardFromScrap(void);

// document handling routines:
extern  OSErr  CreateNewDocument(void);
extern  OSErr  OpenDocument(LetterDescriptor *,void *);
extern  OSErr  PrintDocument(LetterDescriptor *,void *);
extern  Boolean  QuitApplication(void);

SetupApplication() is where you’ll do your application specific initialization. You’ll have to learn what Sprocket does and doesn’t do for you. For example, Sprocket doesn’t set up QuickTime and it only installs handlers for the four required Apple events.

In TearDownApplication(), your documents have already been closed and you know that your application is going down. Here’s a chance to write out your preferences file, shut down any network connections, etc.

HandleMenu() is your menu selection dispatch routine. The first parameter is a pointer to an object that represents the active window at the time the selection was made. The second parameter is a standard four byte menu/item combination you can take apart with HiWord() and LoWord(). You can dispatch menu selections using C or C++, whichever works for you. That’s one of the nice things about Sprocket. Though it is definitely C++ based, it doesn’t force you to work in C++. The generic Sprocket application does all its menu item processing inside the HandleMenu() routine, but you’ll probably want to shift the processing into a separate file.

The routines ReadLocalClipboardFromScrap() and WriteLocalClipboardToScrap() load the scrap into the local clipboard and write the local clipboard back out to the scrap. You’ll fill these routines in when you’re ready to support the Cut, Copy, and Paste Edit menu items.

CreateNewDocument() gets called by the oapp Apple event handler. No matter what horrid error you encounter, do not exit the program inside this routine or you will completely hose the Apple Event Manager. Use this routine to create a new document object. If you encounter an error, return the error code, otherwise return noErr.

OpenDocument() gets called by the odoc Apple Event handler for each document used to launch the application. A recordable application will also create and send an odoc event to itself when the user selects Open... from the File menu. At this point, Sprocket is not recordable (sounds like an idea for a future column). OpenDocument() should use the information in the LetterDescriptor parameter to open a file and use the information in the file to create a new document object. A LetterDescriptor is a union, holding either an FSSpec or an AOCE letter spec. The union starts with a boolean that indicates which type it is. Again, be sure you don’t exit directly from this routine. If you encounter an error, return the error code, otherwise return noErr.

PrintDocument() will get called in response to a pdoc Apple event. Sprocket doesn’t have printing support yet, so leave this routine until printing is there.

QuitApplication() gets called in response to a quit Apple event. QuitApplication() should close every open document. You might want to maintain a list of open document objects, then have QuitApplication() step through the list, calling each document’s Close() member function (also known as the document’s Close() method). If a document has been changed since it was opened, the Close() method should put up the standard “Save changes” alert, giving the user the chance to cancel the quit. If the user cancels the quit, QuitApplication() should return false. If all the documents close successfully, QuitApplication() should return true, and Sprocket will call TearDownApplication().

Till Next Month

In next month’s column, we’ll take a look at the files that define the window objects used by Sprocket. We’ll customize Sprocket by overriding some of the different window Draw() methods. Between now and then, take some time to read through the files App.cp, DocWindow.cp, ToolWindow.cp, PreferencesDialogWIndow.cp, and MailableDocWindow.cp. Experiment. Open up the “.h” file associated with each of these files and check out the class definition that forms the basis for each file. You’ll see that each of these window classes is derived from Sprocket’s TWindow class. Check out the DocWindow class. Notice that it overrides the TWindow Draw() method. If you want to affect what gets drawn in a DocWindow, you’ll want to edit the DocWindow Draw() method. Try it! Just be sure to make a copy of the Sprocket project file and AppSpecific folder so you’ll maintain your original copy of Sprocket (just in case).

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Bartender 3.0.32 - Organize your menu-ba...
Bartender lets you organize your menu-bar apps by hiding them, rearranging them, or moving them to Bartender's Bar. You can display the full menu bar, set options to have menu-bar items show in the... Read more
Adobe Animate CC 2018 18.0.1.115 - Anima...
Animate CC 2018 is available as part of Adobe Creative Cloud for as little as $19.99/month (or $9.99/month if you're a previous Flash Professional customer). Animate CC 2018 (was Flash CC) lets you... Read more
Adobe Lightroom Classic CC 7.1 - Import,...
Adobe Lightroom is available as part of Adobe Creative Cloud for as little as $9.99/month bundled with Photoshop CC as part of the photography package. Lightroom 6 is also available for purchase as a... Read more
ExpanDrive 6.1.8 - 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
ExpanDrive 6.1.8 - 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
DiskCatalogMaker 7.2.7 - Catalog your di...
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 for... Read more
DiskCatalogMaker 7.2.7 - Catalog your di...
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 for... Read more
Iridient Developer 3.2.1 - Powerful imag...
Iridient Developer (was RAW Developer) is a powerful image-conversion application designed specifically for OS X. Iridient Developer gives advanced photographers total control over every aspect of... Read more
BusyContacts 1.2.7 - Fast, efficient con...
BusyContacts is a contact manager for OS X that makes creating, finding, and managing contacts faster and more efficient. It brings to contact management the same power, flexibility, and sharing... Read more
MegaSeg 6.0.5 - Professional DJ and radi...
MegaSeg is a complete solution for pro audio/video DJ mixing, radio automation, and music scheduling with rock-solid performance and an easy-to-use design. Mix with visual waveforms and Magic... Read more

Latest Forum Discussions

See All

The best deals on the App Store this wee...
A new week means new discounts on the App Store. This week's deals run the gamut of action-adventure titles, puzzle games, and one of the best narrative adventure series out there. If you're looking to fill out your mobile gaming library on a... | Read more »
What you need to know about Animal Cross...
We hope you've been hard at work on collecting all of those holiday items in Animal Crossing: Pocket Camp, because you're about to get a whole new list of fun things to do as the game receives its first big update sometime soon. There are a lot of... | Read more »
Reigns: Her Majesty guide - how to use e...
Ruling a kingdom isn't easy--doubly so for a queen whose every decision is questioned by the other factions seeking a slice of power. Reigns: Her Majesty builds on the original game's swipey tactics, adding items that you can use to move the story... | Read more »
The best new games we played this week -...
Friday has crept up on us once again, so it's time to honor the best new games we've played over the past few days. This past week was a pretty exciting one, with the debut of lots of beautiful new indies and some familiar faces returning to the... | Read more »
Portal Knights guide- beginner tips and...
Portal Knights is finally making the jump to iOS and Android, and it's already climbing the ranks to become the next big MMO experience on mobile. This sprawling sandbox game will let you pursue any adventure you wish, whether you want to sling... | Read more »
Reigns: Her Majesty guide - how to swipe...
Reigns: Her Majesty is storming the App Store this week, bringing more tinder-esque kingdom building to eager players everywhere. If you've played the original Reigns, you'll know that leading a kingdom is never easy. It's a careful balancing act... | Read more »
Getting Over It (Games)
Getting Over It 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: A game I madeFor a certain kind of person To hurt them. • Climb up an enormous mountain with nothing but a hammer and a pot.•... | Read more »
Reigns: Her Majesty (Games)
Reigns: Her Majesty 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »
Pocket Legends Adventures guide - how to...
Pocket Legends Adventures is a fun action adventure RPG that takes control when you want it to, but also opens itself for player input, too, if you're looking to tkae a more active role in combat. Regardless of play style, the game can be quite... | Read more »
Portal Knights (Games)
Portal Knights 1.2.4 Device: iOS Universal Category: Games Price: $4.99, Version: 1.2.4 (iTunes) Description: Craft your adventure. Forge your hero. Become the ultimate Portal Knight! | Read more »

Price Scanner via MacPrices.net

Green Monday deal: 15″ 2.8GHz MacBook Pro on...
B&H Photo has the 15″ 2.8GHz Space Gray MacBook Pro on sale for $250 off MSRP for today only as part of their Green Monday/Holiday sale. Shipping is free, and B&H charges sales tax for NY... Read more
Green Monday sale: B&H offers 12″ Apple i...
B&H Photo has 12″ iPad Pros on sale for up to $150 off MSRP as part of their Green Monday/Holiday sale. Shipping is free, and B&H charges sales tax in NY & NJ only: – 12″ 64GB WiFi iPad... Read more
Holiday deal: 21″ and 27″ Apple iMacs on sale...
MacMall has 2017 21″ and 27″ Apple iMacs on sale for up to $200 off MSRP. Shipping is free: – 21″ 2.3GHz iMac: $999 $100 off MSRP – 21″ 3.0GHz iMac: $1199 $100 off MSRP – 21″ 3.4GHz iMac: $1379 $120... Read more
Holiday deal: Apple Mac minis for up to $150...
MacMall has Mac minis on sale for up to $100 off MSRP, each including free shipping: – 1.4GHz Mac mini: $399 $100 off MSRP – 2.6GHz Mac mini: $599 $100 off MSRP – 2.8GHz Mac mini: $949 $50 off MSRP... Read more
Beats by Dr. Dre – BeatsX Earphones on sale f...
Best Buy has BeatsX Earphones on sale for $109, $40 off, on their online store. Sale price for online orders only. Choose free store pickup, if available, or choose free shipping. Read more
10″ 64GB WiFi Apple iPad Pros on sale for $59...
MacMall has 10.5″ 64GB Apple iPad Pros on sale for $599 including free shipping. That’s $50 off MSRP and among the lowest prices available for these iPads from any Apple reseller. Read more
15″ 2.2GHz MacBook Pros on sale for $200-$300...
B&H Photo has the 15″ 2.2GHz MacBook Pro available for $200 off MSRP including free shipping plus NY & NJ sales tax only: – 15″ 2.2GHz MacBook Pro (MJLQ2LL/A): $1799 $200 off MSRP Apple has... Read more
Holiday sale: 15″ MacBook Pros for $200-$420...
MacMall has 15″ MacBook Pros on sale for $220-$300 off MSRP, each including free shipping: – 15″ 2.8GHz MacBook Pro Space Gray (MPTR2LL/A): $2179, $220 off MSRP – 15″ 2.8GHz MacBook Pro Silver (... Read more
Holiday sale: 13″ MacBook Airs for up to $150...
B&H Photo has 13″ MacBook Airs on sale for $100 off MSRP as part of their Holiday sale. Shipping is free, and B&H charges sales tax for NY & NJ residents only: – 13″ 1.8GHz/128GB MacBook... Read more
The best Holiday sale prices on 13″ MacBook P...
B&H Photo has 13″ MacBook Pros on sale this weekend, with models available for $100-$150 off MSRP. Shipping is free, and B&H charges sales tax for NY & NJ residents only: – 13-inch 2.3GHz... Read more

Jobs Board

*Apple* Retail - Multiple Positions - Apple,...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Information Security - Security Data...
# Apple Information Security - Security Data Analyst Job Number: 113119545 Austin, Texas, United States Posted: 10-Nov-2017 Weekly Hours: 40.00 **Job Summary** This Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.