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

GarageSale 7.0.7 - Create outstanding eB...
GarageSale is a slick, full-featured client application for the eBay online auction system. Create and manage your auctions with ease. With GarageSale, you can create, edit, track, and manage... Read more
SpamSieve 2.9.28 - Robust spam filter fo...
SpamSieve is a robust spam filter for major email clients that uses powerful Bayesian spam filtering. SpamSieve understands what your spam looks like in order to block it all, but also learns what... Read more
Thunderbird 45.7.1 - Email client from M...
As of July 2012, Thunderbird has transitioned to a new governance model, with new features being developed by the broader free software and open source community, and security fixes and improvements... Read more
Opera 43.0.2442.991 - High-performance W...
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
OnyX 3.2.4 - Maintenance and optimizatio...
OnyX is a multifunction utility that you can use to verify the startup disk and the structure of its system files, to run miscellaneous maintenance and cleaning tasks, to configure parameters in the... Read more
VueScan 9.5.71 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
Slack 2.5.1 - Collaborative communicatio...
Slack is a collaborative communication app that simplifies real-time messaging, archiving, and search for modern working teams. Version 2.5.1: New The way we load teams you don't view often has been... Read more
HandBrake 1.0.3 - Versatile video encode...
HandBrake is a tool for converting video from nearly any format to a selection of modern, widely supported codecs. Features Supported Sources VIDEO_TS folder, DVD image or real DVD (unencrypted... Read more
Vivaldi 1.7.735.46 - An advanced browser...
Vivaldi is a browser for our friends. In 1994, two programmers started working on a web browser. Our idea was to make a really fast browser, capable of running on limited hardware, keeping in mind... Read more
Vivaldi 1.7.735.46 - An advanced browser...
Vivaldi is a browser for our friends. In 1994, two programmers started working on a web browser. Our idea was to make a really fast browser, capable of running on limited hardware, keeping in mind... Read more

Last week on Pocket Gamer
If you’re wondering what’s going on in the wider world of portable gaming, our sister site PocketGamer has you covered. Each week we like to check in on the PG team and see what they’ve been preoccupied with. From the latest on the Nintendo Switch... | Read more »
Mudd Masher arrives this week
Atooi Games, the minds behind Totes the Goat and Mutant Mudds, have a new game in the works -- Mudd Masher. The game, a hybrid of the independent studio's first two titles, is expected to launch this week on March 2. [Read more] | Read more »
The best sales on the App Store this wee...
The App Store has quite an exciting lineup of discount games this week that range across a variety of genres. It's a great opportunity to catch up on some of the premium games you may have been holding off on -- and some you can even grab for free... | Read more »
The best new games we played this week
Ah, here we are again at the close of another busy week. Don't rest too easy, though. We had a lot of great new releases in mobile games this week, and now you're going to have to spend all weekend playing them. That shouldn't be too much of a... | Read more »
Rollercoaster Tycoon Touch Guide: How to...
| Read more »
Rabbids Crazy Rush Guide: How to unlock...
The Rabbids are back in a new endless running adventure, Rabbids Crazy Rush. It's more ridiculous cartoon craziness as you help the little furballs gather enough fuel (soda) to get to the moon. Sure, it's a silly idea, but everyone has dreams --... | Read more »
Tavern Guardians (Games)
Tavern Guardians 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Tavern Guardians is a Hack-and-Slash action game played in the style of a match-three. You can experience high pace action... | Read more »
Slay your way to glory in idle RPG Endle...
It’s a golden age for idle games on the mobile market, and those addictive little clickers have a new best friend. South Korean developer Ekkorr released Endless Frontier last year, and players have been idling away the hours in the company of its... | Read more »
Tiny Striker: World Football Guide - How...
| Read more »
Good news everyone! Futurama: Worlds of...
Futurama is finding a new home on mobile in TinyCo and Fox Interactive's new game, Futurama: Worlds of Tomorrow. They're really doing it up, bringing on board Futurama creator Matt Groening along with the original cast and writers. TinyCo wants... | Read more »

Price Scanner via MacPrices.net

13-inch 2.7GHz Retina MacBook Pro on sale for...
B&H Photo has the 2015 13″ 2.7GHz/128GB Retina Apple MacBook Pro on sale for $150 off MSRP. Shipping is free, and B&H charges NY tax only: - 13″ 2.7GHz/128GB Retina MacBook Pro (MF839LL/A): $... Read more
13-inch 1.6GHz/256GB MacBook Air on sale for...
Newegg has the 13″ 1.6GHz/256GB MacBook Air (MMGG2LL/A) on sale for $1029.99 including free shipping. Their price is $170 off MSRP, and it’s the lowest price available for this model. Choose Newegg... Read more
Apple refurbished Apple TVs available for up...
Apple has Certified Refurbished 32GB and 64GB Apple TVs available for up to $30 off the cost of new models. Apple’s standard one-year warranty is included with each model, and shipping is free: -... Read more
27-inch 3.3GHz 5K iMac on sale for $2099, sav...
B&H Photo has the 27″ 3.3GHz 5K Apple iMac on sale for $2099.99 including free shipping plus NY sales tax only. Their price is $200 off MSRP. Amazon also has the 27″ 3.3GHz 5K iMac on sale for $... Read more
21-inch iMacs on sale for up to $111 off MSRP
B&H Photo has select 21″ Apple iMacs on sale for up to $110 off MSRP, each including free shipping plus NY sales tax only: - 21″ 2.8GHz iMac: $1189 $110 off MSRP - 21″ 1.6GHz iMac: $999 $100 off... Read more
12-inch 1.2GHz Retina MacBooks on sale for $2...
Newegg has the 12″ 1.2GHz Space Gray Retina MacBook (sku MLH82LL/A) on sale for $1349.99 including free shipping. Their price is $250 off MSRP, and it’s the lowest price available for this model.... Read more
13-inch MacBook Airs on sale for $100 off MSR...
B&H Photo has 13″ MacBook Airs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 1.6GHz/128GB MacBook Air (MMGF2LL/A): $899 $100 off MSRP - 13″ 1.6GHz/... Read more
9-inch 32GB Silver iPad Pro on sale for $549,...
B&H Photo has the 9.7″ 32GB Silver Apple iPad Pro on sale for $549 for a limited time. Shipping is free, and B&H charges NY sales tax only. Their price is $50 off standard MSRP for this model... Read more
13-inch 2.0GHz Apple MacBook Pros on sale for...
B&H has the non-Touch Bar 13″ 2.0GHz MacBook Pros in stock today and on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.0GHz MacBook Pro Space Gray (... Read more
15-inch Touch Bar MacBook Pros on sale for up...
B&H Photo has the new 2016 15″ Apple Touch Bar MacBook Pros in stock today and on sale for up to $150 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.7GHz Touch Bar... Read more

Jobs Board

*Apple* Solutions Consultant - Apple (United...
# Apple Solutions Consultant Job Number: 55676865 Los Angeles, California, United States Posted: Feb. 22, 2017 Weekly Hours: 40.00 **Job Summary** As an Apple Read more
Programmer/Editor *Apple* Music Dance - App...
# Programmer/Editor Apple Music Dance Job Number: 55565967 Culver City, California, United States Posted: Feb. 23, 2017 Weekly Hours: **Job Summary** Apple Music Read more
Digital Marketing Specialist - *Apple* iClo...
# Digital Marketing Specialist - Apple iCloud Job Number: 54729233 Culver City, California, United States Posted: Feb. 22, 2017 Weekly Hours: 40.00 **Job Summary** Read more
Marketing Specialist, iTunes & *Apple*...
# Marketing Specialist, iTunes & Apple Music Job Number: 55704205 Culver City, California, United States Posted: Feb. 23, 2017 Weekly Hours: 40.00 **Job Summary** Read more
*Apple* Wireless Lead - T-ROC - The Retail O...
…of knowledge in wireless sales and activations to the Beautiful and NEW APPLE Experiencestore within MACYS. THIS role, APPLE Wireless Lead, isbrandnewas MACYS Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.