TweetFollow Us on Twitter

March 94 - Print Hints

Print Hints

TRACKING QUICKDRAW GX MESSAGES

PETE ("LUKE") ALEXANDER

[IMAGE 032-035_Print_Hints_rev1.GIF]

In this column, I'd like to bring a tool called MessageWatcher to your attention. This tool, which is provided on this issue's CD, will help you understand the messages sent to your QuickDraw GX printer driver or printing extension when an application prints a document through the QuickDraw GX system.

A LITTLE BACKGROUND
develop Issue 15 gave an overview of QuickDraw GX in the article "Getting Started With QuickDraw GX" and discussed the QuickDraw GX messaging system in "Developing QuickDraw GX Printing Extensions." You can also learn about QuickDraw GX printing and messaging inInside Macintosh: QuickDraw GX Printing Extensions and Drivers . If you've read these and don't need a refresher, you can just skip to the next section.

QuickDraw GX's extensible printing architecture makes writing printer drivers easier than ever. Easier yet is writing printing extensions, which allow you to modify the behavior of the QuickDraw GX printing system (similar to the way system extensions let you change the system by patching traps).

When an application prints through the QuickDraw GX system, QuickDraw GX either performs the requested task or sends a message (via the Message Manager) to the printer driver to perform the task. The QuickDraw GX printing system defines over 150 messages. For many tasks, QuickDraw GX provides a default implementation for the associated message, but sends a message to the driver anyway. The driver can then perform the task in its own way or massage the message parameters before forwarding the message on to the default implementation. In a printing extension, you can intercept and override any message before it gets to the printer driver.

ABOUT MESSAGEWATCHER AND OUR EXAMPLE
With over 150 messages in the QuickDraw GX printing system, it's a little difficult to follow the flow of the messages through the system or figure out their default implementation. MessageWatcher helps you with this by showing the messages being sent while an application is printing a document. This "live" view is very helpful toward understanding the calling chain and hierarchy of messages.

The MessageWatcher application and system extension are on this issue's CD. To use MessageWatcher, first drop the system extension into the System Folder and reboot; then launch the MessageWatcher application. Whenever any application initiates a print job, a window corresponding to that job will be opened in MessageWatcher and the messages sent as part of the job will scroll past. The title of each MessageWatcher window contains the internal ID of the job. (You should view the internal ID of a job similar to the way you view a file reference number today.)

The QuickDraw GX Finder printing extension (which is part of the QuickDraw GX system extension) and PrinterShare GX are treated like any other applications printing through the QuickDraw GX printing system. So they each have a print job associated with them, andMessageWatcher displays windows for them as well. If you were to create a desktop printer with the Chooser, there would also be a window for the Chooser.

As an example, we're going to print a document created and displayed by the "All Shapes with Printing" sample application, which is part of the sample code included with QuickDraw GX. This sample creates all of the shapes possible within the graphics system. Below is the code that prints the page of shapes; keep it in mind while going through the example of using MessageWatcher in the next section.

OSErr DoPrintOneCopy (WindowPtr myWindow)
{
	Str255windowTitle;
	OSErr printError = noErr;
	
	if (myWindow)
	{
		GetWTitle(myWindow, windowTitle);
		// Start sending the job. The job has the 
		// same name as our window and contains 
		// one page. This name appears in the
		// status messages sent to the desktop
		// printer.
		GXStartJob(gDocumentJob, windowTitle, 1);
		
		// Send the entire page of shapes to the
		// printer. (All the shapes being printed
		// have been collected into the GX picture
		// shape: gthePage.)
		GXPrintPage(gDocumentJob, 1, 
				GXGetJobFormat(gDocumentJob, 1), 
				gthePage);
		
		// Tell QuickDraw GX printing we're done
		// sending the job, so terminate the
		// spooling process.
		GXFinishJob(gDocumentJob);
		
		if (GXGetJobError(gDocumentJob) != noErr) 
			// Your error-handling code here!
	}
}

We're going to look at our sample application printing to a LaserWriter II SC, so the message sequence displayed by MessageWatcher contains messages that are sent to a raster printer. Note that most of the messages would be different if we were printing to a PostScript® printer or to a plotter.

Each line in a MessageWatcher window consists of a message preceded by one of the following labels: send message, send object, and send object to. These labels represent the similarly named API calls in the Message Manager -- for example, "send message" corresponds to the SendMessage call. All the "send" labels are roughly equivalent, so you'll be able to follow along well enough without distinguishing between them; if you do want more information about the Message Manager calls, see Chapter 6, "Message Manager," inInside Macintosh: QuickDraw GX Environment and Utilities .

While going through the various MessageWatcher windows in the next section, I won't bore you with a line-by-line discussion of everything displayed in each window. I'll give you the general idea behind the information presented; by checking out the documentation and trying out MessageWatcher yourself on different applications, you'll be able to figure out these details easily enough.

WHAT MESSAGEWATCHER DISPLAYS
The first time our sample application calls the QuickDraw GX printing API, the QuickDraw GX Finder printing extension initializes the default printer and then shuts down. The MessageWatcher window for this extension contains the following (the window title is shown in boldface; the ID displayed in each title will be different when you run MessageWatcher yourself):

Finder: 0x0000fac4

send object to: initialize
send object: defaultPrinter
send object to: shutDown

You'll also see PrinterShare GX start up a couple of times: The first time, it performs some general spool file and desktop printer queue management; it examines all the spool files and makes sure that the print jobs that are waiting are handled in the appropriate order. The second time it runs, it starts up the print job. The MessageWatcher window for PrinterShare GX displays this:

PrinterShare GX: 0x0000fa3c

send object to: initialize
send object: defaultPrinter
send object to: initialize
send object: defaultPrinter
send object: defaultPaperType
send object: defaultFormat
send object: defaultJob
send object: defaultPaperType
send object to: shutDown

Notice that MessageWatcher indents some of information in the window, allowing you to see the message hierarchy. For example, the above window shows that the recipient of the defaultJob message sent the message in the indented line below it, defaultPaperType.

The next application to send messages through the system is our sample application, All Shapes with Printing. In this case, we chose Print One Copy from the File menu of the application to start the printing process. The application starts by setting up various default printing structures associated with the print job.

All Shapes with Printing: 0x00990c

send object to: initialize
send object: defaultPrinter
send object to: initialize
send object: defaultPrinter
send object: defaultPaperType
send object: defaultFormat
send object: defaultJob
	send object: defaultPaperType

Now we'll see the actual messages sent to print a document. Our sample application is ready to start up the print job and create the spool file. It uses GXPrintPage to print the document; you'll see the startJob and finishJob messages in the MessageWatcher window because GXPrintPage sends these messages in its default implementation. Next, the data contained on the page is spooled to disk. Finally, the print job is finished, and the spool file is closed and waiting for PrinterShare GX to find it and send it to the printer.

send object: startJob
	send message: createSpoolFile
	send object: jobStatus
send object: printPage
	send message: StartPage
		send object: jobStatus
	send message: finishPage
		send message: spoolPage
			send message: spoolData
			send message: spoolData
			send message: spoolData
			send message: spoolData
			send message: spoolData
send object: finishJob
	send message: completeSpoolFile
		send object: spoolResource
	send object: jobStatus
send object to: shutDown

The QuickDraw GX printing system is now ready to send the data contained in the spool file to the printer. PrinterShare GX starts by checking the status of the printer and then writing (that is, sending) the data. It continues to write the data and check the device status until all the data is sent. If a status check were to reveal that an error had occurred, the error would be available via GXGetJobError to the driver or extension (not to the application, which is usually out of the printing process at this point). Once all the data has been sent to the printer, PrinterShare GX checks the status of the printer one last time, makes sure the print job was successful, closes the spool file, and shuts down. We now have a piece of paper coming out of the printer.

PrinterShare GX: 0x00092520

send message: getDeviceStatus
send message: writeData
	send message: getDeviceStatus
		lots of writeData and getDeviceStatus
		messages to send the data to the printer
	send message: writeData
	send message: checkStatus
send object: jobStatus
send object: closeSpoolFile
send object to: shutDown

The MessageWatcher window for the QuickDraw GX Finder printing extension shows the messages it receives to update the status information being displayed in the desktop printer's window. In this case, the status is updated six times during the process of printing the document. To see exactly what status information is being sent to the desktop printer's window, you could open the window yourself and take a look. Remember, the messages will be slightly different for different types of printers -- PostScript, raster (QuickDraw based), and plotter.

Finder: 0x000912dc

send object: writeStatusToDTPWindow
send object: writeStatusToDTPWindow
send object: writeStatusToDTPWindow
send object: writeStatusToDTPWindow
send object: writeStatusToDTPWindow
send object: writeStatusToDTPWindow

WATCH OUT NOW . . .
Following the flow of messages through the QuickDraw GX printing system will give you a better understanding of the calling chain and hierarchy of messages that are sent while a document is being printed. With MessageWatcher, you have the power to peek into the world of QuickDraw GX messaging. Happy exploring!

THE RETURN OF 'STR ' (-8192)

In the Print Hints column in Issue 13 of develop , I talked about the disappearance of 'STR ' (-8192) and'PAPA' (-8192) resources from a system running QuickDraw GX and how your application should be prepared to handle this situation. The 'PAPA' (-8192) resource is still gone, but the 'STR ' (-8192) resource, containing the name of the default printer driver, has returned. Unfortunately, there are a few applications that require this resource to be present to run correctly -- in some cases, to run at all. Since we wanted old applications to have the highest possible compatibility while printing through a QuickDraw GX system, we put the resource back. However, as mentioned in Issue 13, it's still not a good idea to depend on the information in 'STR ' (-8192).

REFERENCES

  • Inside Macintosh: QuickDraw GX Printer Drivers and Extensions  and Inside Macintosh: QuickDraw GX Environment and Utilities.  On-line versions accompany QuickDraw GX releases; printed manuals will soon be available (Addison-Wesley, 1994).
  • "Getting Started With QuickDraw GX" by Pete ("Luke") Alexander and "Developing QuickDraw GX Printing Extensions" by Sam Weiss, develop  Issue 15.
  • "Print Hints: Looking Ahead to QuickDraw GX" by Pete ("Luke") Alexander, develop Issue 13.

PETE ("LUKE") ALEXANDER will tell you that life at Apple is hard. He spends long days (and frequent nights) with smart people trying to figure out what the right thing is and how to make it happen. Then he gets sent all over the world to tell people about what's new and happening. Last year Luke went to London and walked around the streets for ten hours trying to fend off jet lag and punk rockers, to Madrid where he had an unforgettable chocolate shake, to Milan where he saw the basement of the Apple building and tried not to take it personally that they wouldn't let him near a window, to Munich and Frankfurt where he finally understood why Germans gush about their beer, and to Sweden where he gave his QuickDraw GX talk in a discotheque filled with engineers who couldn't get the beat. After these whirlwind tours, Luke soars above the stress in his glider, but only occasionally takes an Apple Evangelist along, since they seem to think they've got connections up there and are forever telling him how to fly. Yes, life at Apple is hard, but after five years, Luke's beginning to get the hang of it. *

Buried deep within QuickDraw GX is an About box. The exercise of how to get to this box is left for the reader. *

Thanks to Hugo Ayala, Tom Dowdy, and Dave Hersey for reviewing this column. *

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

OmniGraffle 7.2.2 - Create diagrams, flo...
OmniGraffle helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use Graffle to... Read more
OmniGraffle Pro 7.2.2 - Create diagrams,...
OmniGraffle Pro helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use... Read more
OmniGraffle Pro 7.2.2 - Create diagrams,...
OmniGraffle Pro helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use... Read more
OmniGraffle 7.2.2 - Create diagrams, flo...
OmniGraffle helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use Graffle to... Read more
Spotify 1.0.44.100. - Stream music, crea...
Spotify is a streaming music service that gives you on-demand access to millions of songs. Whether you like driving rock, silky R&B, or grandiose classical music, Spotify's massive catalogue puts... Read more
Microsoft OneNote 15.29 - Free digital n...
OneNote is your very own digital notebook. With OneNote, you can capture that flash of genius, that moment of inspiration, or that list of errands that's too important to forget. Whether you're at... Read more
WALTR 2 2.0.8 - $39.95
WALTR 2 helps you wirelessly drag-and-drop any music, ringtones, videos, PDF, and ePub files onto your iPhone, iPad, or iPod without iTunes. It is the second major version of Softorino's critically-... Read more
Dropbox 16.3.27 - Cloud backup and synch...
Dropbox is an application that creates a special Finder folder that automatically syncs online and between your computers. It allows you to both backup files and keep them up-to-date between systems... Read more
EtreCheck 3.1.5 - For troubleshooting yo...
EtreCheck is an app that displays the important details of your system configuration and allow you to copy that information to the Clipboard. It is meant to be used with Apple Support Communities to... Read more
Carbon Copy Cloner 4.1.12 - Easy-to-use...
Carbon Copy Cloner backups are better than ordinary backups. Suppose the unthinkable happens while you're under deadline to finish a project: your Mac is unresponsive and all you hear is an ominous,... Read more

Latest Forum Discussions

See All

Track Santa with these three festive app...
Christmas is fast approaching and that means it's time to prepare for Santa's yearly pilgrimage around the globe. Christmas Eve is an exciting time as parents help their kids get ready to welcome Santa. You've got the cookies and milk all planned... | Read more »
Galaxy on Fire 3 and four other fantasti...
Galaxy on Fire 3 - Manticore brings the series back for another round of daring space battles. It's familiar territory for folks who are familiar with the franchise. If you've beaten the game and are looking to broaden your horizons, might we... | Read more »
The best apps for your holiday gift exch...
What's that, you say? You still haven't started your holiday shopping? Don't beat yourself up over it -- a lot of people have been putting it off, too. It's become easier and easier to procrastinate gift shopping thanks to a number of apps that... | Read more »
Toca Hair Salon 3 (Education)
Toca Hair Salon 3 1.0 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »
Winter comes to Darkwood as Seekers Note...
MyTona, based in the chilly Siberian city of Yakutsk, has brought a little festive fun to its hidden object game Seekers Notes: Hidden Mystery. The Christmas update introduces some new inhabitants to players, and with them a chance to win plenty of... | Read more »
Bully: Anniversary Edition (Games)
Bully: Anniversary Edition 1.03.1 Device: iOS Universal Category: Games Price: $6.99, Version: 1.03.1 (iTunes) Description: *** PLEASE NOTE: This game is officially supported on the following devices: iPhone 5 and newer, iPod Touch... | Read more »
PINE GROVE (Games)
PINE GROVE 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: A pine grove where there are no footsteps of people due to continuous missing cases. The case is still unsolved and nothing has... | Read more »
Niantic teases new Pokémon announcement...
After rumors started swirling yesterday, it turns out there is an official Pokémon GO update on its way. We’ll find out what’s in store for us and our growing Pokémon collections tomorrow during the Starbucks event, but Niantic will be revealing... | Read more »
3 reasons why Nicki Minaj: The Empire is...
Nicki Minaj is as business-savvy as she is musically talented and she’s proved that by launching her own game. Designed by Glu, purveyors of other fine celebrity games like cult favorite Kim Kardashian: Hollywood, Nicki Minaj: The Empire launched... | Read more »
Clash of Clans is getting its own animat...
Riding on its unending wave of fame and success, Clash of Clans is getting an animated web series based on its Clash-A-Rama animated shorts.As opposed to the current shorts' 60 second run time, the new and improved Clash-A-Rama will be comprised of... | Read more »

Price Scanner via MacPrices.net

New 2016 13-inch Touch Bar MacBook Pros on sa...
B&H Photo the new 2016 Apple 13″ 2.9GHz/256GB Touch Bar MacBook Pros on sale for $50 off MSRP, each including free shipping plus NY sales tax only: - 13″ 2.9GHz/256GB Touch Bar MacBook Pro Space... Read more
12-inch 1.2GHz Space Gray Retina MacBook on s...
B&H Photo has dropped their price on the 2016 Apple 12″ 1.2GHz Space Gray Retina MacBook (MLH82LL/A) to $1399 including free shipping plus NY sales tax only. Their price is $200 off MSRP, and it’... Read more
Never Settle for Low Performing Wifi With iOS...
AppYogi Software has announced the release of WiFi Signal Strength Status App 1.0, the company’s new utility developed exclusively for macOS. WiFi Signal Strength Status App features a unique, single... Read more
New 2016 13-inch Touch Bar MacBook Pros in st...
B&H Photo has stock of new 2016 Apple 13″ Touch Bar MacBook Pro models, each including free shipping plus NY sales tax only: - 13″ 2.9GHz/512GB Touch Bar MacBook Pro Space Gray: $1999 - 13″ 2.... Read more
New 2016 15″ Touch Bar MacBook Pros in stock...
B&H Photo has new 2016 Apple 15″ Touch Bar MacBook Pro models in stock today including free shipping plus NY sales tax only: - 15″ 2.7GHz Touch Bar MacBook Pro Space Gray: $2799 - 15″ 2.7GHz... Read more
DietSensor App Targeting Diabetes and Obesity...
DietSensor, Inc., a developer of smart food and nutrition applications designed to fight diabetes and obesity and help improve overall fitness, has announced the launch of its DietSensor app for... Read more
Holiday 2016 13-inch 2.0GHz MacBook Pro sales...
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
Holiday sale: Apple TVs for $51-$40 off MSRP,...
Best Buy has dropped their price on the 64GB Apple TV to $159.99 including free shipping. That’s $40 off MSRP. 32GB Apple TVs are on sale right now for $98 on Sams Club’s online store. That’s $51 off... Read more
12-inch Retina MacBooks, Apple refurbished, n...
Apple has restocked a full line of Certified Refurbished 2016 12″ Retina MacBooks, now available for $200-$260 off MSRP. Refurbished 2015 models are available starting at $929. Apple will include a... Read more
Holiday sale: 12-inch Retina MacBook for $100...
B&H has 12″ Retina MacBooks on sale for $100 off MSRP as part of their Holiday sale. Shipping is free, and B&H charges NY sales tax only: - 12″ 1.1GHz Space Gray Retina MacBook: $1199 $100... Read more

Jobs Board

Integration Technician, *Apple* - Zones, In...
…at Zones and for our customers each day. Position Overview The Apple Integration Technician will be responsible for performing customer specific configuration 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
*Apple* Retail - Multiple Positions- Trumbul...
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* 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
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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.