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 );
}

 
AAPL
$106.98
Apple Inc.
-0.36
MSFT
$46.05
Microsoft Corpora
-0.57
GOOG
$550.31
Google Inc.
+0.98

MacTech Search:
Community Search:

Software Updates via MacUpdate

Cocktail 8.0.1 - General maintenance and...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
LibreOffice 4.3.3.2 - Free Open Source o...
LibreOffice is an office suite (word processor, spreadsheet, presentations, drawing tool) compatible with other major office suites. The Document Foundation is coordinating development and... Read more
VMware Fusion 7.0.1 - Run Windows apps a...
VMware Fusion allows you to create a Virtual Machine on your Mac and run Windows (including Windows 8.1) and Windows software on your Mac. Run your favorite Windows applications alongside Mac... Read more
OneNote 15.3.2 - Free digital notebook f...
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
Audio Hijack Pro 2.11.4 - Record and enh...
Audio Hijack Pro drastically changes the way you use audio on your computer, giving you the freedom to listen to audio when you want and how you want. Record and enhance any audio with Audio Hijack... Read more
Iridient Developer 3.0.0 beta 3 - Powerf...
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
TextWrangler 4.5.11 - Free general purpo...
TextWrangler is the powerful general purpose text editor, and Unix and server administrator's tool. Oh, and also, like the best things in life, it's free. TextWrangler is the "little brother" to... Read more
NeoFinder 6.6 - Catalog your external me...
NeoFinder (formerly CDFinder) rapidly organizes your data, either on external or internal disks, or any other volumes. It catalogs all your data, so you stay in control of your data archive or disk... Read more
Chromium 38.0.2125.111 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. FreeSMUG-Free OpenSource Mac User Group build is... Read more
Default Folder X 4.6.11 - Enhances Open...
Default Folder X attaches a toolbar to the right side of the Open and Save dialogs in any OS X-native application. The toolbar gives you fast access to various folders and commands. You just click... Read more

Latest Forum Discussions

See All

Audio Defence : Zombie Arena (Games)
Audio Defence : Zombie Arena 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: A zombie shooter audio game. Made from gut-wrenching 3D binaural sound, for a new kind of weird immersion. You... | Read more »
RPG Asdivine Hearts (Games)
RPG Asdivine Hearts 1.1.0 Device: iOS Universal Category: Games Price: $3.99, Version: 1.1.0 (iTunes) Description: SPECIAL PRICE50% OFF (USD 7.99 -> USD 3.99)!!! Travel alongside four companions and a cat in the adventure of a... | Read more »
Haunt the House: Terrortown (Games)
Haunt the House: Terrortown 1.0.1 Device: iOS Universal Category: Games Price: $.99, Version: 1.0.1 (iTunes) Description: 66.6% OFF! SPECIAL SPOOKY HALLOWEEN LAUNCH PRICE! 66.6% OFF! ...What was that sound? Is somebody there? | Read more »
SAS: Zombie Assault 4 Review
SAS: Zombie Assault 4 Review By Jennifer Allen on October 30th, 2014 Our Rating: :: FLAWED SHOOTERUniversal App - Designed for iPhone and iPad Shoot everything that moves in this fun, if flawed, twin-stick shooter.   | Read more »
Naailde the Witch Review
Naailde the Witch Review By Amy Solomon on October 30th, 2014 Our Rating: :: PITCH-PERFECT STORYTELLINGUniversal App - Designed for iPhone and iPad Marvelous storytelling, narration, and moving illustrations make this storybook... | Read more »
1st & Goal Review
1st & Goal Review By Andrew Fisher on October 30th, 2014 Our Rating: :: FOR THE D&D LOVING QBUniversal App - Designed for iPhone and iPad 1st & Goal is a board gamer’s football game, a football fan’s board game, and... | Read more »
French Developer Pated Unveils Seashine
French Developer Pated Unveils Seashine Posted by Ellis Spice on October 30th, 2014 [ permalink ] French one-man studio Pated has unveiled Seashine, “a poetic journey into the abyss.” Players take on the role of a jellyfish strugglin | Read more »
Agents of Storm: Tips, Tricks, and Strat...
Calling all agents: Would you like to see what we thought of this rather pretty base builder? Check out our Agents of Storm review! Have you downloaded Agents of Storm, been bowled over by the graphics, and aren’t quite sure what to do next? Never... | Read more »
Any.DO 2.0 Hopes to Help Manage Producti...
Any.DO 2.0 Hopes to Help Manage Productivity Posted by Ellis Spice on October 30th, 2014 [ permalink ] iPhone App - Designed for the iPhone, compatible with the iPad | Read more »
Base Busters Review
Base Busters Review By Jennifer Allen on October 30th, 2014 Our Rating: :: FUN BUT RESTRICTED MIXUniversal App - Designed for iPhone and iPad Mixing up two forms of tower defense gaming and collectible cards, Base Busters is a fun... | Read more »

Price Scanner via MacPrices.net

Apple Regains Momentum As Windows Stutters An...
The latest smartphone sales data from Kantar Worldpanel ComTech, for the three months to March 2014, shows Apple performing strongly in the first quarter of the year, with sales bouncing back in... Read more
Worldwide Smartphone Shipments Increase 25.2%...
New smartphone releases and an increased emphasis on emerging markets drove global smartphone shipments above 300 million units for the second consecutive quarter, according to preliminary data from... Read more
Apple now offering refurbished 2014 15-inch M...
The Apple Store is now offering Apple Certified Refurbished 2014 15″ Retina MacBook Pros for up to $400 off the cost of new models. An Apple one-year warranty is included with each model, and... Read more
Apple drops prices on refurbished 2013 Retina...
The Apple Store has dropped prices on 2013 Apple Certified Refurbished 13″ and 15″ Retina MacBook Pros, with Retina models now available starting at $999. Apple’s one-year warranty is standard, and... Read more
New 2.8GHz Mac mini on sale for $949, save $5...
Abt Electronics has the new 2.8GHz Mac mini in stock and on sale for $949.05 including free shipping. Their price is $50 off MSRP, and it’s the lowest price available for this model from any reseller... Read more
Sale! 3.7GHz Quad Core Mac Pro available for...
 B&H Photo has the 3.7GHz Quad Core Mac Pro on sale for $2649 including free shipping plus NY sales tax only. Their price is $350 off MSRP, and it’s the lowest price for this model from any... Read more
Mujjo Steps Up The Game With Refined Touchscr...
Netherlands based Mujjo have just launched their Refined Touchscreen Gloves, stepping up their game. The gloves feature a updated elegant design that takes these knitted gloves to the next level. A... Read more
Sale! Preorder the new 27-inch 5K iMac for $2...
 Abt Electronics has the new 27″ 3.5GHz 5K iMac on sale and available for preorder for $2374.05 including free shipping. Their price is $125 off MSRP, and it’s the lowest price available for this... Read more
Simplex Solutions Inc. Brings Secure Web Surf...
New York based Simplex Solutions Inc. has announced the release and immediate availability of Private Browser 1.0, its revolutionary new secure web browser developed for iPhone, iPad and iPod touch... Read more
Save up to $180 off MSRP with an Apple refurb...
The Apple Store has Apple Certified Refurbished 2014 MacBook Airs available for up to $180 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is free.... Read more

Jobs Board

Position Opening at *Apple* - Apple (United...
**Job Summary** Every day, business customers come to the Apple Store to discover what powerful, easy-to-use Apple products can do for them. As a Business Leader, Read more
Sr. Manager, *Apple* Deployment Programs fo...
**Job Summary** Apple is seeking candidates for a new position on the Education Content and Technology team. iPad and Mac is in the hands of millions of teachers and Read more
*Apple* Solutions Consultant (ASC) - Apple I...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include: * Promoting Apple products and solutions Read more
*Apple* Solutions Consultant (ASC) - Apple I...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include: * Promoting Apple products and solutions Read more
*Apple* Solutions Consultant (ASC) - Apple I...
…important role that the ASC serves is that of providing an excellent Apple Customer Experience. Responsibilities include: * Promoting Apple products and solutions Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.