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

MacUpdate Desktop 6.0.8 - Search and ins...
MacUpdate Desktop 6 brings seamless 1-click installs and version updates to your Mac. With a free MacUpdate account and MacUpdate Desktop 6, Mac users can now install almost any Mac app on macupdate.... Read more
BitTorrent Sync 2.1.1 - Sync files secur...
BitTorrent Sync allows you to sync unlimited files between your own devices, or share a folder with friends and family to automatically sync anything. File transfers are encrypted. Your information... Read more
Quicksilver 1.3.0 - Application launcher...
Quicksilver is a light, fast and free Mac application that gives you the power to control your Mac with keystrokes alone. Quicksilver allows you to find what you need quickly and easily, then act... Read more
iWatermark Pro 1.72 - Easily add waterma...
iWatermark Pro is the essential watermarking app for professional, business, and personal use. iWatermark, is the number 1 and only watermarking tool available for all 4 platforms iPhone/iPad, Mac,... Read more
RapidWeaver 6.3 - Create template-based...
RapidWeaver is a next-generation Web design application to help you easily create professional-looking Web sites in minutes. No knowledge of complex code is required, RapidWeaver will take care of... Read more
Adobe Photoshop CC 2015 16.0.1 - Profess...
Photoshop CC 2015 is available as part of Adobe Creative Cloud for as little as $19.99/month (or $9.99/month if you're a previous Photoshop customer). Photoshop CS6 is still available for purchase (... Read more
Together 3.4.6 - Store and organize all...
Together helps you organize your Mac, giving you the ability to store, edit and preview your files in a single clean, uncluttered interface. Smart storage. With simple drag-and-drop functionality,... Read more
Monosnap 3.1.0 - Versatile screenshot ut...
Monosnap lets you capture screenshots, share files, and record video and .gifs! Capture: Capture full screen, just part of the screen, or a selected window Make your crop area pixel perfect with... Read more
Cocktail 8.5.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
Vienna 3.0.6 :5eaf312: - RSS and Atom ne...
Vienna is a freeware and Open-Source RSS/Atom newsreader with article storage and management via a SQLite database, written in Objective-C and Cocoa, for the OS X operating system. It provides... Read more

Five Nights at Freddy's 4 has Been...
In keeping with tradition, Five Nights at Freddy's 4 has made its way to the App Store with zero warning fanfare. Honestly I'd be disappointed it if happened any other way at this point. [Read more] | Read more »
Doom & Destiny Advanced (Games)
Doom & Destiny Advanced 2.3.4.0 Device: iOS Universal Category: Games Price: $.99, Version: 2.3.4.0 (iTunes) Description: ---SUPER GIGA LAUNCH DISCOUNT! Get it now for cheap or pay more later!---An additional 143 MB download is... | Read more »
Five Nights at Freddys 4 (Games)
Five Nights at Freddys 4 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: This time, the terror has followed you home. | Read more »
This Week at 148Apps: July 27-31, 2015
Winding Down July With 148Apps How do you know what apps are worth your time and money? Just look to the review team at 148Apps. We sort through the chaos and find the apps you're looking for. The ones we love become Editor’s Choice, standing out... | Read more »
You'll Want to Keep an Eye Out for...
If you're the kind of person who had fun hunting down and completing all the codex puzzles in Assassin's Creed 2, then are you ever in for a treat. The Guides looks like it's going to be a very robust collection of similarily odd, seemingly... | Read more »
Vivid Games has Announced Real Boxing 2...
The original Real Boxing was a pretty impressive bit of fisticuffs, but if the trailer Vivid Games is showing off for GamesCom is any indication Real Boxing 2 is going to be even better. [Read more] | Read more »
PAC-MAN Championship Edition DX - Tips,...
[Read more] | Read more »
Card King: Dragon Wars - Tips, Tricks an...
[Read more] | Read more »
Pac-Man Championship Edition DX has brou...
Bandai Namco has released Pac-Man Championship Edition DX on iOS and Android, which features the classic arcade gameplay that we've all grown to love. Pac-Man Championship Edition DX can be enjoyed in much shorter bursts than the arcade versions... | Read more »
Cosmonautica (Games)
Cosmonautica 1.1 Device: iOS Universal Category: Games Price: $6.99, Version: 1.1 (iTunes) Description: Cast off! Are you ready for some hilarious adventures in outer space? | Read more »

Price Scanner via MacPrices.net

MacBook 12 Retina Pundit’s New Favorite Mac
If you’re eyeing the purchase of a new 12-inch Retina MacBook, but wondering if you can live with a single USB-C port, 2011-level CPU performance, and the unorthodox keyboard, you should find... Read more
PDF Element Tool Kit For PDF For Windows 10,...
South Surrey, British Columbia based software developer Wondershare has posted an interesting infographic tracking the development of Microsoft’s flagship Windows operating system over the years,... Read more
27-inch 3.5GHz 5K iMac on sale for $81 off MS...
Adorama has the 27″ 3.5GHz 5K iMac on sale for $2218, $81 off MSRP, including a free copy of Apple’s 3-Year AppleCare Protection Plan. Shipping is free, and Adorama charges sales tax in NY & NJ... Read more
Back-to-School with Tablet and Smartphone Acc...
Belkin helps you prepare for the coming school year with a wide variety of the latest mobile and tablet accessories to outfit both grade school and college students. The line-up includes charging... Read more
11-inch MacBook Airs on sale for $100 off MSR...
Best Buy has 11-inch MacBook Airs on sale for $100 off MSRP. Choose free shipping or free local store pickup (if available). Sale prices for online orders only, in-store prices may vary: - 11″ 1.6GHz... Read more
iPad Air 2 on sale for up to $100 off MSRP
Best Buy has iPad Air 2s on sale for up to $100 off MSRP on their online store for a limited time. Choose free shipping or free local store pickup (if available). Sale prices available for online... Read more
Sale! 13-inch MacBook Pros on sale for $100 o...
B&H Photo has 13″ MacBook Pros on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.5GHz/500GB MacBook Pro: $999.99 save $100 - 13″ 2.7GHz/128GB Retina... Read more
Sale! Save $100 on 13-inch MacBook Airs this...
B&H Photo has the 13″ 1.6GHz/128GB MacBook Air on sale for $899.99 including free shipping plus NY tax only. Their price is $100 off MSRP, and it’s the lowest price available for this model.... Read more
Worldwide Tablet Market Decline Continues, Ap...
The worldwide tablet market declined -7.0% year-over-year in the second quarter of 2015 (2Q15) with shipments totaling 44.7 million units according to preliminary data from the International Data... Read more
TP-LINK TL-PA8030P KIT Powerline Featuring Ho...
Consumer and business networking products provider TP-LINK is now shipping its TL-PA8030P KIT AV1200 3-Port Gigabit Passthrough Powerline Starter Kit that expands your home’s network over its... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
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
Infrastructure Engineer - *Apple* /Mac - Hil...
Infrastructure Engineer - Apple /Mac Job Code: 1608 # of openings: 1 Description Our fortune 500 client is looking to hire an experienced Infrastructure Engineer to join Read more
Executive Administrative Assistant, *Apple*...
…supporting presentation development for senior leadership. * User experience with Apple hardware and software is preferred. Additional Requirements The following list Read more
*Apple* Bus Company is now hirin - Apple Bus...
Apple Bus Company is now hiring school bus drivers in the Pettis County area. Class B CDL preferred. Free training provided. No nights or weekends required. Flexible Read more
*Apple* Certified Mac Technician - Updated 6...
…and friendly, hands-on technical support to customers troubleshooting and repairing Apple /Mac products with courtesy, speed and skill. Use your problem-solving skills Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.