TweetFollow Us on Twitter

Windoid XCMD
Volume Number:6
Issue Number:12
Column Tag:XCMD Corner

Related Info: Event Manager Window Manager

Windoids and HyperCard 2.0

By Donald Koscheka, MacTutor Contributing Editor

If you’ve been writing XCMDs for some time now, you might be a little concerned over how much work is involved in porting your xcmds to Hypercard 2.0. For the most part, this is a trivial process and you need not modify any of your code to support Hypercard 2.0. You will need to recompile with the new xcmd libraries though as the callback engine has been completely re-written to allow for a larger number of callbacks (some 75 as opposed to the 30 or so in HC1.0; the number is a little vague because I found a few callbacks in the library that are not documented anywhere).

For those of you using Think “C”, you will need to convert the XCMD library, “HyperXLib.o” to a Think “C” library. I got this file in MPW format and ran the “oConv” utility on it to convert it to something that Think can use. I then built a library from this. There is one small catch, the Library entry points are all uppercase. You will need to modify your calls to uppercase. For example, PasToZero becomes PASTOZERO. Of course, you might just wait until someone comes along with a more convenient library than the one that is currently distributed.

As I said, your xcmd should work “for the most part”. Certain xcmds will not work very well under Hypercard 2.0 or they will work but their behaviour will be such that you won’t recognize them (kind of like my 2 year old when she skips her nap).

The reason for this is that Hypercard 2.0 implements a completely new external window schema which offers a tremendous benefit to the xcmd writer but which also requires that you rethink your windowing strategy. The benefit of making your xcmds HC2.0 “windoid” friendly is tremendous -- windoids that function in the HC windoid layer will be able to communicate directly with Hypercard and use the Hypercard callbacks. In effect, you get a multiple-window Hypercard stack.

Windoids don’t come for free in Hypercard 2.0 and that’s good. In effect, Apple is leaving it up to each developer to decide what to do with external windows. The only rules that you must obey are those that will allow your windows to function within the external windows layer. This way, your windows will work correctly with other xcmds that also create external windows. Hypercard keeps track of which windows are owned by which xcmds, and it passes window events to each external windoid appropriately.

Windoids.c

Listing 1, “Windoids.c” is an external window xcmd skeleton. It incorporates two new functions of HC 2.0 xcmds: (1) it handles the “?” and “!” queries from the user and (2) it responds to windoid events. The former was covered last month is quite straightforward. We will look at the windoid events in greater detail in this and future columns.

Take a look at the entry point in Listing 1. Note that the first thing we do is check the number of parameters being passed to us by Hypercard. If the parameter count is less than zero (specifically, -1), then we are being passed an external windoid event for a window that we created earlier. If there is only one parameter and it’s “?” or “!” then return the appropriate information about the xcmd back to the caller. In the case of the “?”, you should return usage information. In the case of the “!” you should return a note about who created the xcmd and what it does. This is also a good place to put your copyright notice.

If the parameter count is greater than or equal to zero, then you treat the parameters as ordinary xcmd parameters. However, if the parameter count is less than zero, then you decode the parameter block in an entirely different manner. In this case, the first parameter, params[0] (“C”) or params[1] (Pascal), contains a POINTER to an xcmd event record. This record contains the following fields:

/* 1 */
 
struct XWEventInfo {
 EventRecordevent;
 WindowPtreventWindow;
 long   eventParams[9];
 Handle eventResult;
 }XWEventInfo, *XWEventInfoPtr;

The eventrecord is identical to the event manager event record. The windowPtr is a pointer to the windoid that should get this event. The event parameters and event result have other meanings that we will no doubt explore in the future but which are not required for the code in Listing 1.

In the listing, we call HandleHCEvent with the xcmd parameter block if paramcount is less than zero, otherwise we move to HandleHCmessage which should treat the parameter block like an ordinary xcmd activation. After a little thought this mechanism begs a question -- if we are responding to events in HandleHCEvent, why do we pass the entire parameter block rather than just the xwindow event record? This question gives rise to yet another question -- if that’s the case, why isn’t the parameter block just declared thusly:

/* 2 */

 typedef union{
 XCmdPBlock xcmdParams;
 XWEventInfoxwEventRecord;
 }

These questions did seem troubling to me at first -- I like to pass only those parameters that will be needed by a routine to that routine. An event handler should not need access to the parameter block, should it? The answer is absolutely and herein lies the answer -- by passing the entire parameter block to HandleHCevent, we are able to access Hypercard globals and make callbacks from inside our event loop. The answer to the second question should now be obvious -- we need to keep the parameter block intact so that xcmds can get to the callbacks. Thus the mechanism developed for handling events is correct. We can put our minds at ease and get back to the business of writing the code which is always easier once you develop this sort of intuitive feel for the data that you’re working with; a concept which is axiomatic in object oriented programming, by the way.

If your code needs to dispathc to HandleHCMessage, then you can treat the activation as a routine xcmd call and do whatever you like in HandleHCMessage. You might create a new external window here or close an existing window. Keep in mind that you should not directly call the toolbox calls to open and close windows. Rather, you must use the calls, NewXWindow and CloseXwindow which will create the windows for you and “register” them in the xwindow layer. Aside from that, window management is almost identical in Hypercard as in a stand-alone application.

/* 3 */

extern pascal WindowPtr NEWXWINDOW( XCmdPtr paramPtr,
 Rect *boundsRect,
 StringPtr title, 
        Boolean visible,
 short procID,
 Boolean color,
 Boolean floating); 

extern pascal WindowPtr GETNEWXWINDOW(XCmdPtr paramPtr,
 ResType  templateType,
 short  templateID,
 Boolean  color,
 Booleanfloating);  
extern pascal void CLOSEXWINDOW(XCmdPtr paramPtr, WindowPtr window);

When you create an external window, you use either the call to NewXWindow or the call to GetNewXWindow. Don’t draw in the window or do anything more yet. Hypercard will tell you when the window is ready for use by sending your event loop an Xwindow event called “xOpenEvt”. Not until your xcmd gets this event are you guaranteed to have a window that is ready for use.

At openEvt, you might want to invalidate the window to force an update or append some private data to the refcon. What you do is up to you, just don’t do anything to the window until you get the xOpenEvt.

Similarly, if you have a call to xwindoids of the form: Xwindoids “Close”, windowID then you should do nothing more than issue a call to CloseXWindow and go away. Later on, your xcmd will get the “xCloseEvt” event. At this time you can deallocate any private memory that the window uses and set the passFlag to true advising Hypercard that it’s okay to close the window.

Between xOpenEvt and xCloseEvt, your window will receive more or less normal events and should respond to them in a more or less normal fashion. Things start getting a little fuzzy here as I have noticed that this event loop can have different behaviors depending on what you do with the passflag. The code in Listing 1 does work, and you might want to play with the event loop to learn a little more about the behaviour of xwindows (or xwindoids as I prefer to call them to avoid confusion with that other windowing environment).

Pay particular attention to the goaway and drag code in listing 1. The goaway method does nothing more than advise Hypercard that the user wants to close the window. Later on, HC will pass back to use the xCloseEvt event. In the meantime, the window should just be in limbo.

The drag code works fine here. I discovered that setting the passflag to true will cause Hypercard to handle dragging the window. I hope to learn more about these undocumented parts of the window code as we go along. The content, activate and update methods are pure vanilla. On activate, we just check to see if we’re going active. I take the liberty of invalidating the window to force an update, but this should not be necessary. The invalRgn should be accumulated correctly for the window.

One last thing I would like to recommend is how you respond to suspend/resume events. I like the idea of hiding all my windows on suspend so that they aren’t in the way of the next application. On resume, you should show those windows that were visible at the last suspend. You will need to keep a separate flag for this, the window’s visible won’t be much use here.

In subsequent articles, we’ll hang more decorations on this skeleton and explore Hypercard xWindoids in greater detail. In the meanwhile, take a little time to master listing 1 and get comfortable with this “call and wait” mechanism for opening and closing windows. Overall I think the structure is quite workable and should lead to some very exciting extensions to Hypercard 2.0 in the future. If you discover anything about HC2.0 that you would like to share with your fellow developers, please drop me a line. My new AppleLink is D6845. See you next month.

Listing:  Windoids.c

/************************************/
/* File: Donald Koscheka.c*/
/* --------------------------------*/
/* ©1990 Donald Koscheka  */
/* All Rights Reserved    */
/************************************/
#include<HyperXCMD.h>
#include<HyperUtils.h>
#include<SetUpA4.h>

#ifndef MouseMovedEvt
#define MouseMovedEvt0xFA 
 /* Mouse moved event code*/
#endif
#ifndef SuspendResumeEvt
#define SuspendResumeEvt  0x01
 /* Suspend/Resume event code */
#endif
#define ResumeEvtMask0x1  
 /* Supend or Resume selector */
#define ConvertScrapMask  0x2 
 /* Scrap conversion flag */

pascal void HandleHCEvent( XCmdPtr pp);
pascal void HandleHCMessage( XCmdPtr pp);
pascal void UpdateWindow( WindowPtr wind );
pascal void DoContent(  WindowPtr wind, XWEventInfoPtr ip);

pascal void main( pp )
 XCmdPtrpp;
/************************************
* MAIN ENTRY POINT
************************************/
{
 pp->returnValue = NIL;
 
 if( pp->paramCount < 0 )
 HandleHCEvent( pp );
 else{
 if( pp->paramCount == 1 )
 if( **(pp->params[0]) == '!'  || **(pp->params[0]) == '?' ){
 switch(  **(pp->params[0]) ){
 case '!': 
 pp->returnValue = PASTOZERO( pp, "\pWindoids ©1990, 1991 Donald Koscheka, 
Inc.");
 return;
 case '?':
 pp->returnValue = PASTOZERO( pp, "\pWindoids [command] <parameters>" 
);
 return;
 }
 }
 HandleHCMessage( pp ); 
 }
 UnloadA4Seg( 0L );
 RestoreA4();
}

pascal void HandleHCEvent( pp )
 XCmdPtrpp;
/**********************************
* Handle events in our xWindows  
* returns true if the event was handled ok
**********************************/
{
 short  windoPart;
 Rect   r;
 XWEventInfoPtr  ip= pp->params[0];
 WindowPtrwhichWindow;
 
 pp->passFlag = FALSE;

 switch( ip->event.what ){
 case mouseDown:
 whichWindow = ip->eventWindow;
 windoPart = FindWindow( ip->event.where, &whichWindow );
 if( whichWindow )
 switch ( windoPart ){
 case inGoAway:
 if (TrackGoAway(whichWindow, ip->event.where)) {
 CLOSEXWINDOW( pp,whichWindow );
 pp->passFlag = FALSE;
 }
 break;
 case inDrag: /* handled by hypercard */
 pp->passFlag = TRUE;
 break;
 case inGrow:
 break;
 case inContent:
 if (whichWindow != FrontWindow() )
 SelectWindow( whichWindow );
 else{
 DoContent( whichWindow, ip );
 }
 pp->passFlag = TRUE;
 break;
 default: 
 break;
 }/* window part */
 break;
 case mouseUp:
 break;
 case keyDown:
 case autoKey:
 break;
 case activateEvt: /* [DK] ON ACTIVATE, DRAW THE MENUS,
 ON DEACTIVATE HIDE THE MENUS */
 if ( ip->event.modifiers & activeFlag ){
 r= (ip->eventWindow)->portRect;
 InvalRect( &r );
 }
 pp->passFlag = TRUE;
 break;
 case updateEvt: 
 UpdateWindow(  ip->eventWindow );
 pp->passFlag = TRUE;
 break;
 case app4Evt:
 {
 unsigned char *evtType = &(ip->event.message);
 
 switch( *evtType ){
 case MouseMovedEvt:
 break;
 case SuspendResumeEvt:
 if( ip->event.message & ResumeEvtMask )
 show_all_windows();
 else
 hide_all_windows();
 break;
 }
 }
 pp->passFlag = TRUE;
 break;
 case xOpenEvt:
 ShowWindow( ip->eventWindow );
 pp->passFlag = TRUE;
 break;
 case xCloseEvt:
 pp->passFlag = TRUE;
 break;
 default: 
 break; 
 } /* switch theEvent->what */
}

pascal void DoContent( wind, ip )
 WindowPtrwind;
 XWEventInfoPtr  ip;
/*************************************
* Handle the content region in a mouse down in an xwindow. ip is  a pointer 
to the HyperXevent record, needed to see where the mouse is and what 
the modifiers are.
*************************************/
{ SetPort( wind ); }

pascal void HandleHCMessage( pp )
 XCmdPtrpp;
/*****************************************
* Hypercard has sent us a message which we need to respond to. The command 
is passed in parameter 1 and the arguments are passed in parameter 2..N
* Perhaps you'll add a little parser here to accept valid commands and 
dispatch to the correct command handler. You may pass a command here 
called "openwindow" and another called "closewindow" to allow users to 
create & destroy external windows. 
*****************************************/
{ }

pascal void UpdateWindow( xwind )
 WindowPtrwind;
/******************
* Draw the contents of the window.
* You need to develop some mechanism for storing window specific data. 
 You might try storing the info in the window's refcon.  The choice is 
up to you.  
******************/
{
 BeginUpdate( wind );
 SetPort( wind );
 ClipRect( &wind->portRect );
 EndUpdate( wind );
}

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

A beginner's guide to Spellbinders
Spellbinderslooks a heck of a lot like Clash Royale, but has an entirely different pace to it. As such, it can be difficult to adjust to. Just in case you've been playing way too much Clash Royale (and who hasn't), we've put together a bunch of... | Read more »
Camping With Grandpa (Education)
Camping With Grandpa 1.0 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »
Black Hole Joyrider (Games)
Black Hole Joyrider 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Guide your spacecraft through the gravity well of a powerful black hole using only your retro-thrusters and dwindling fuel... | Read more »
My Koi (Games)
My Koi 1.0 Device: iOS iPhone Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: My Koi is a beautiful and relaxing fish pond app. Customise and name each fish. Feed them daily. Watch them grow. Collect new fish.... | Read more »
Never Gone (Games)
Never Gone 1.0.2 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.2 (iTunes) Description: ###IMPPORTANT### Never Gone's HD art resources require devices with more than 1GB RAM, so please note that iPhone 4/4s, iPad 2/... | Read more »
INKS. (Games)
INKS. 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: From the makers of BAFTA-winning Lumino City comes INKS. INKS updates pinball for a new generation. It combines the joy of pinball with... | Read more »
How to maximise your profits in Bakery B...
Running a bakery can be an expensive venture. You’ll need to continuously upgrade your oven, your kitchen supplies, and even your ingredients to keep customers happy. Most of these renovations in Bakery Blitz cost a pretty penny, but we have a few... | Read more »
How to manage your time in Bakery Blitz
It can be tricky, especially when you risk burning your kitchen to the ground if you forget a cake in the oven, so make sure to use these time management tricks to keep your bakery running smoothly. Don’t collect the money right away [Read more] | Read more »
Model 15 (Music)
Model 15 1.0 Device: iOS iPhone Category: Music Price: $29.99, Version: 1.0 (iTunes) Description: The Moog Model 15 App is the first Moog modular synthesizer and synthesis educational tool created exclusively for iPad, iPhone and... | Read more »
How to deal with wind in Angry Birds Act...
Angry Birds Action! is a physics-based puzzler in which you're tasked with dragging and launching birds around an obstacle-littered field to achieve a set objective. It's simple enough at first, but when wind gets introduced things can get pretty... | Read more »

Price Scanner via MacPrices.net

Hybrid Tablets Meet Rising Demand for a Singl...
Rising demand for a new breed of hybrid tablets — 2 in 1 devices that function as either a laptop or a tablet — is shaking up the tablet market and contributing to a shift in the way owners are... Read more
Bausch + Lomb and IBM Collaborate on iPhone...
Global eye health company Bausch + Lomb, and IBM on Thursday announced a collaboration to develop the first app of its kind for iPhone and iPad for surgeons who perform cataract surgery. The... Read more
Apple & SAP Partner to Deliver New iOS Ap...
Apple and Walldorf, Germany based SAP have announced a partnership to revolutionize the mobile work experience for enterprise customers of all sizes, combining powerful native apps for iPhone and... Read more
New 12-inch 1.1GHz Rose Gold Retina MacBook o...
B&H Photo has the new 2016 12″ 1.1GHz/256GB Rose Gold Retina MacBook (sku MMGL2LL/A) on sale for $1199 including free shipping plus NY tax only. Their price is $100 off MSRP, and it’s the lowest... Read more
12-inch 128GB iPad Pros on sale for up to $10...
B&H Photo has 12″ 128GB WiFi iPad Pros on sale for up to $100 off MSRP, each including free shipping. B&H charges sales tax in NY only: - 12″ Space Gray 128GB WiFi iPad Pro: $899 $50 off MSRP... Read more
Global Tablet Sales Slump Continues, iPad’s F...
Another miserable showing for the global slate tablet category in calendar Q1/16, with global tablet shipments falling another 1ten percent to 46.5 million units during the according to Strategy... Read more
Revel Systems to Showcase iPad POS Platform w...
Revel Systems, specialists in iPad Point of Sale management solution for brick-and-mortar retail, food businesses and more, today announced that it will showcase its innovative iPad Point of Sale... Read more
13-inch 2.5GHz MacBook Pro on sale for $999,...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $999 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Read more
Apple refurbished 2015 iMacs available for up...
Apple now has a full line of Certified Refurbished 2015 21″ & 27″ iMacs available for up to $350 off MSRP. Apple’s one-year warranty is standard, and shipping is free. The following models are... Read more
Indian Smartphone Market Grows Annually by 12...
India’s smartphone market grew by 12 percent year-over-year, with 24.4 million units shipping in Q1 2016. The top five vendors stayed the same, with Samsung in the lead, followed by Micromax, Intex... Read more

Jobs Board

*Apple* Support Technician II - Worldventure...
…global, fast growing member based travel company, is currently sourcing for an Apple Support Technician II to be based in our Plano headquarters. WorldVentures is Read more
*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, 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
Automotive Sales Consultant - Apple Ford Linc...
…you. The best candidates are smart, technologically savvy and are customer focused. Apple Ford Lincoln Apple Valley is different, because: $30,000 annual salary 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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.