TweetFollow Us on Twitter

XCMD Shell
Volume Number:9
Issue Number:6
Column Tag:Object-programming

Think C Shell for XCMDs

Incorporating XCMDs into your application without alteration

By Gerry H. Kenner, Magna, Utah

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.

About the author

Gerry Kenner is a professional electrical and computer engineering consultant, university researcher and sometimes writer who specializes in image analysis systems for investigative scientists.


Recently, I submitted an article to MacTech Magazine entitled “Three Subclasses for Screen Input/Output” in which I described the creation of three THINK C classes which I use as general utilities when developing applications. These classes were named BGetTCLInfo, BDisplayDoc and BBitMapDoc whose functions were to ask for data input, output data and output bitmap dumps respectively. In this article, I am going to show how BGetTCLInfo and BDisplayDoc can be used for development of XCMDs. The use of two other classes, BEditDoc and BEditPane will also be demonstrated.

The idea is to write XCMDs in such a way that they can be incorporated in either THINK C application or code resource projects without alteration. The XCMD can be written in standard C or it can be object oriented. Once incorporated into a THINK C object oriented application shell, standard debugging techniques can be used to follow the execution of the code.

The code resource project consists of the standard main function for interfacing with HyperCard. This function then calls the code for the XCMD which is in a separate file.

The application project is somewhat more complicated in that it initially creates an object of class BGetTCLInfo for getting whatever information is needed by the XCMD, puts it in HyperCard usable form, executes the XCMD code and then uses a BDisplayDoc object to pass the results back to the programmer.

If the programmer wants to use HyperTalk utility functions, he must create a code file named something like HyperUtil.c (or HyperXcmd.c for that matter) and provide alternate source code for any functions called. I have not done this because I feel that HyperTalk utilities should be avoided in favor of THINK C library functions or SANE toolbox calls.

I haven’t had occasion to try it but programming windoids may be a problem.

Descriptions of the classes BGetTCLInfo, BDisplayDoc, BEditDoc and BEditPane are not included in this article. The reader will need to obtain the February, 1993 issue (page 18) of MacTech Magazine in which they are described and/or purchase a copy of the MacTech Magazine disk for this issue to get the source code. [Or you can download it from one of the online services. - Ed.]


As in my previous article, I am only including the code necessary to understand the project. This code is enough for an intermediate programmer to fill in what is missing. Typically, I do not declare variables or state which header files must be included. A copy of the complete project is available on the MacTech Magazine disk.



This is a regular code resource with the difference that code resource specific code is included in the main function while a call is made to the XCMD code which is in a separate file. In this example the code necessary for setting up A4 addressing will not execute properly in a standalone application so it executed in the main function of the XCMD.


Create a new project named Flash.Π and two empty code files named FlashXCMD.c and Flash.c. Incorporate these files as well as the libraries ANSI-A4 and MacTraps into the project. Flash.c will contain the XCMD code that is common to both the code resource project and the application project. FlashXCMD.c will contain the main function of the Flash code resource.

Set up the project to build a code resource named FlashXCMD of type XCMD with a resource number such as 30.


The code of the main function is as follows:

/* 1 */
pascal void main(XCmdPtr pp)
 RememberA0();   //Setup and save register A4



RememberA0 and SetUpA4 set up A4 addressing while RestoreA4 removes it. FlashMain is a call to the XCMD code. For the above code to compile, it is necessary to #include the files SetUpA4.h and Flash.h.

FlashMain is part of a file named Flash.c. It contains code for flashing the screen and beeping the number of times the user specifies in the HyperCard stack where the XCMD is called. It then returns this number to HyperCard. Its code is as follows. This method is based on a HyperCard XCMD demonstration program originally written by Apple Computer.

/* 2 */

#include <string.h>
#include <QuickDraw.h>
#include “Flash.h”

pascal void FlashMain(XCmdPtr paramPtr)
 short  again;
 long   flashCount;
 Handle returnHdl;
 Str255 str, tempStr;

 // First param is flash count.  
 // Convert it to a pascal string
 returnHdl = NewHandle(256L);
 (char*)*(unsigned char **)paramPtr->params[0]);
 // Convert the string to a number
 StringToNum(str, &flashCount);
 // Invert the screen and sound the beep.
 for (again = 0; again < flashCount; again++) 
 // Build the return string.
 strcpy((char*)tempStr, “The number of flashes was “);
 strcat((char*)tempStr, (char*)str);
 strcat((char*)tempStr, “ “);
 strcat((char*)tempStr, (char*)”\r”);
 strcpy((char*)*returnHdl, (char*)tempStr);
 paramPtr->returnValue = returnHdl;

Short, brief and simple as an example should be. The only other thing you need to know is that Flash.h contains the prototype declaration of the function FlashMain and #includes HyperXCmd.h.

Create a HyperCard stack named Flash Stack with one button which contains the following script.

/* 3 */

on mouseUp
  put FlashXCMD(5) into msg
end mouseUp

Compile the code resource and merge it with the above stack. Run the XCMD to confirm that it is functional.



The purpose of this object oriented code is to provide a dialog box asking for input, convert it to a HyperCard usable format, call the XCMD code and then display return information.


The easiest way to get the necessary project is to make a copy of THINK C’s Starter Project, compile it and then make the appropriate name changes, i.e., Starter.Π to FlashObject.Π, Starter.c to FlashObject.c, StarterApp.c to flApp.c, etc. Remove the StarterDoc and StarterPane classes from the project and eliminate any references to them as they are not necessary. In the StarterApp files change all instances of the prefix Starter with fl. Add all the dialog box classes. Add CButton, CCheckBox, CIconPane, CRadioControl and CRadioGroupPane of the control classes. The ANSI and SANE libraries will be required before the project is finished. Finally, add Flash.c from above to the project.


In this case, the main function will look something like this when the changes have been made.

/* 4 */

#include “flApp.h”

void main()
 flApp  *theApp; 

 theApp = new flApp;

The flApp object is entered via the XcmdRun method to avoid complications which would result from overriding the Run method of the CApplication class.

In the flApp class, the methods CreateDocument and OpenDocument must be overridden to become donothing methods or else removed entirely. This is to prevent the creation of unwanted windows.

Four new methods need to be added to the flApp class. These are named XcmdRun, GetParams, FillParamPtr and DumpData. They have the following functions.

XcmdRun Access method. Launch XCMD.

GetParams Get input parameters.

FillParamPtr Convert input parameters to HyperCard readable form.

DumpData Dump results to a window.

XcmdRun gets the input, sends it out for conversion, calls the XCMD and then outputs the result. Its code is as follows.

/* 5 */

void flApp::XcmdRun(void)
 char   returnStr[1024];
 paramPtr = (XCmdPtr)NewPtr(136L); // Size of XCmdBlock.
 FillParamPtr(paramPtr, returnStr);
 // A real program would dispose of paramPtr and its handles
 // at this point.

The parameter data is input by creating an object of class BGetTCLInfo which displays a dialog box containing an edit text box into which information can be entered. The format used for entering the information is “First set of data”,”Second set of data”, etc just as is done in HyperCard scripts. In the case of our example, we would enter something like “3”. By enclosing it between quotes just about anything including 32k text files can be read in this way.

/* 6 */

void flApp::GetParams(char *paramStr)
 #define DLOGinfo601 // Resource ID for DLOG template    
 BGetTCLInfo*theDocument = NULL;
 Rect   boxDescription;
 SetRect(&boxDescription, 20, 20, 260, 60);
 theDocument = new(BGetTCLInfo);
 theDocument->IBGetTCLInfo(DLOGinfo, this);
 theDocument->GetInfo(“Number of flashs”, paramStr);

The FillParamPtr method is a conversion routine which takes data input in the format given above and creates handles pointing to the text between each pair of quotation marks.

/* 7 */

void flApp::FillParamPtr(XCmdPtr paramPtr, char *paramStr)
 short  count = 0;
 size_t theLength;
 char   *tempPtr, *tokenPtr;
 char   tokenStr[256];
 tempPtr = paramStr;
 while (*tempPtr != 0x00)
 tokenPtr = (char*)&tokenStr;
 if (*tempPtr == 0x22)
 while (*tempPtr != 0x22)
 *tokenPtr = *tempPtr;
 if (*tempPtr == 0x2C)
 while (*tempPtr != 0x2C)
 *tokenPtr = *tempPtr;
 *tokenPtr = 0x00;
 theLength = strlen(tokenStr);
 paramPtr->params[count] = NewHandle(theLength + 1);
 strcpy((char*)*(paramPtr->params[count]), tokenStr);
 paramPtr->paramCount = count;

FlashMain was listed above as part of the code resource project. It is found in the Flash.c file.

Once the program has returned from the FlashMain call, the DumpData method is called to create an output window displaying the data returned by the XCMD code. This is done by creating an object of class BDumpData. The code is as follows.

/* 8 */

void flApp::DumpData(Handle theData)
 BDisplayOutput  *theOutput;
 theOutput = new BDisplayOutput;
 theOutput->IBDisplayOutput(this, TRUE);

Use the above listings to add the methods to the flApp.c file. Add the following #include statements.

/* 9 */

#include "flash.h"
#include "CBartender.h"
#include "BGetTCLInfo.h"
#include "BDisplayOutput.h"
#include "size_t.h"
#include "string.h"

Make the appropriate changes in the flApp.h file and add #include “HyperXCmd.h”. Add BGetTCLInfo.c, BDisplayOutput.c, BEditDoc.c and BEditPane.c to the project. Add the DLOG and DITL resources listed below to the resource file. Compile and do whatever additional tweaking is necessary. One of the tweaks will be to increase the project memory to about 500k if it hasn’t already been done.


DLOG and DITL resources numbered 601 must be added to provide a template for the prompt dialog box. This consists of an OK button centered at the bottom, one line of static text at the top with a large edit text box in between. The exact size and layout of the resource are determined by programmer tastes and requirements.


When the project is run, a dialog box will appear soliciting user input. Type in a number in quotation marks such as “5” just as it would appear in the parameter list for a Hypercard call. The computer will then beep for the listed number of times but will not flash. Finally, a window will appear with the message “The number of flashes was 5”. Although interesting, I did not consider it worth the effort for this paper to determine why the screen did not flash on a Power Book 100.


I have been using this system for over a year. The principle advantages over using compiler statements to alternate between creating XCMDs and applications is that readability is not sacrificed and the input/output capabilities make it easy to keep track of what is going on.

I can be reached on internet at and AppleLink at UUTL.


Community Search:
MacTech Search:

Software Updates via MacUpdate

Apple macOS Sierra 10.12.1 - The latest...
With Apple macOS Sierra, Siri makes its debut on Mac, with new features designed just for the desktop. Your Mac works with iCloud and your Apple devices in smart new ways, and intelligent... Read more
Backblaze - Online backup serv...
Backblaze is an online backup service designed from the ground-up for the Mac. With unlimited storage available for $5 per month, as well as a free 15-day trial, peace of mind is within reach with... Read more
Apple Safari 10.0.1 - Apple's Web b...
Note: The direct download link is currently unavailable. It is available in the OS X 10.11.6 release, as well as in the Apple Security Updates. Apple Safari is Apple's web browser that comes with OS... Read more
Postbox 5.0.5 - Powerful and flexible em...
Postbox is a new email application that helps you organize your work life and get stuff done. It has all the elegance and simplicity of Apple Mail, but with more power and flexibility to manage even... Read more
Opera 40.0.2308.90 - High-performance We...
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
Hazel 4.0.7 - Create rules for organizin...
Hazel is your personal housekeeper, organizing and cleaning folders based on rules you define. Hazel can also manage your trash and uninstall your applications. Organize your files using a familiar... Read more
Apple iOS 10.1 - The latest version of A...
iOS 10 is the biggest release of iOS ever. A massive update to Messages brings the power of the App Store to your conversations and makes messaging more personal than ever. Find your route with... Read more
BetterTouchTool 1.93 - Customize Multi-T...
BetterTouchTool adds many new, fully customizable gestures to the Magic Mouse, Multi-Touch MacBook trackpad, and Magic Trackpad. These gestures are customizable: Magic Mouse: Pinch in / out (zoom... Read more
Toast Titanium 15.1 - $99.99
Roxio Toast 15 Titanium, the leading DVD burner for Mac, makes burning even better, adding Roxio Secure Burn to protect your files on disc and USB in Mac- or Windows-compatible formats. Get more... Read more
Coda 2.5.19 - One-window Web development...
Coda is a powerful Web editor that puts everything in one place. An editor. Terminal. CSS. Files. With Coda 2, we went beyond expectations. With loads of new, much-requested features, a few surprises... Read more

Latest Forum Discussions

See All

WitchSpring2 (Games)
WitchSpring2 1.27 Device: iOS Universal Category: Games Price: $3.99, Version: 1.27 (iTunes) Description: This is the story of Luna, the Moonlight Witch as she sets out into the world. This is a sequel to Witch Spring. Witch Spring 2... | Read more »
4 popular apps getting a Halloween makeo...
'Tis the season for all things spooky. So much, so, in fact, that even apps are getting into the spirt of things, dressing up in costume and spreading jack o' lanterns all about the place. These updates bring frightening new character skins, scary... | Read more »
Pokémon GO celebrates Halloween with can...
The folks behind Pokémon GO have some exciting things planned for their Halloween celebration, the first in-game event since it launched back in July. Starting October 26 and ending on November 1, trainers will be running into large numbers of... | Read more »
Best Fiends Forever Guide: How to collec...
The fiendship in Seriously's hit Best Fiends has been upgraded this time around in Best Fiends Forever. It’s a fast-paced clicker with lots of color and style--kind of reminiscent of a ‘90s animal mascot game like Crash Bandicoot. The game... | Read more »
5 apps for the budding mixologist
Creating your own cocktails is something of an art form, requiring a knack for unique tastes and devising interesting combinations. It's easy to get started right in your own kitchen, though, even if you're a complete beginner. Try using one of... | Read more »
5 mobile strategy games to try when you...
Strategy enthusiasts everywhere are celebrating the release of Civilization VI this week, and so far everyone seems pretty satisfied with the first full release in the series since 2010. The series has always been about ultra-addictive gameplay... | Read more »
Popclaire talk to us about why The Virus...
Humanity has succumbed to a virus that’s spread throughout the world. Now the dead have risen with a hunger for human flesh, and all that remain are a few survivors. One of those survivors has just called you for help. That’s the plot in POPCLAIRE’... | Read more »
Oceans & Empires preview build sets...
Hugely ambitious sea battler Oceans & Empires is available to play in preview form now on Google Play - but download it quickly, as it’s setting sail away in just a few days. [Read more] | Read more »
Rusty Lake: Roots (Games)
Rusty Lake: Roots 1.1.4 Device: iOS Universal Category: Games Price: $2.99, Version: 1.1.4 (iTunes) Description: James Vanderboom's life drastically changes when he plants a special seed in the garden of the house he has inherited.... | Read more »
Flippy Bottle Extreme! and 3 other physi...
Flippy Bottle Extreme! takes on the bottle flipping craze with a bunch of increasingly tricky physics platforming puzzles. It's difficult and highly frustrating, but also addictive. When you begin to master the game, the sense of achievement is... | Read more »

Price Scanner via

Apple’s Thursday “Hello Again” Event A Largel...
KGI Securities analyst Ming-Chi Kuo, who has a strong record of Apple hardware prediction accuracy, forecasts in a new note to investors released late last week that a long-overdue redo of the... Read more
12-inch Retina MacBooks on sale for $100 off...
Amazon has 2016 12″ Apple Retina MacBooks on sale for $100 off MSRP. Shipping is free: - 12″ 1.1GHz Silver Retina MacBook: $1199.99 $100 off MSRP - 12″ 1.1GHz Gold Retina MacBook: $1199.99 $100 off... Read more
Save up to $600 with Apple refurbished Mac Pr...
Apple has Certified Refurbished Mac Pros available for up to $600 off the cost of new models. An Apple one-year warranty is included with each Mac Pro, and shipping is free. The following... Read more
PixelStyle Inexpensive Photo Editor For Mac W...
PixelStyle is an all-in-one Mac Photo Editor with a huge range of high-end filters including lighting, blurs, distortions, tilt-shift, shadows, glows and so forth. PixelStyle Photo Editor for Mac... Read more
13-inch MacBook Airs on sale for $100-$140 of...
B&H has 13″ MacBook Airs on sale for $100-$140 off MSRP for a limited time. Shipping is free, and B&H charges NY sales tax only: - 13″ 1.6GHz/128GB MacBook Air (sku MMGF2LL/A): $899 $100 off... Read more
2.8GHz Mac mini available for $988, includes...
Adorama has the 2.8GHz Mac mini available for $988, $11 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
21-inch 3.1GHz 4K on sale for $1379, $120 off...
Adorama has the 21″ 3.1GHz 4K iMac on sale $1379.99. Shipping is free, and Adorama charges NY & NJ sales tax only. Their price is $120 off MSRP. To purchase an iMac at this price, you must first... Read more
Check Apple prices on any device with the iTr...
MacPrices is proud to offer readers a free iOS app (iPhones, iPads, & iPod touch) and Android app (Google Play and Amazon App Store) called iTracx, which allows you to glance at today’s lowest... Read more
Apple, Samsung, Lead J.D. Power Smartphone Sa...
Customer satisfaction is much higher among smartphone owners currently subscribing to full-service wireless carriers, compared with those purchasing service through a non-contract carrier, according... Read more
Select 9-inch Apple WiFi iPad Pros on sale fo...
B&H Photo has select 9.7″ Apple WiFi iPad Pros on sale for up to $50 off MSRP, each including free shipping. B&H charges sales tax in NY only: - 9″ Space Gray 256GB WiFi iPad Pro: $799 $0 off... Read more

Jobs Board

*Apple* Retail - Multiple Positions- Towson,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Software Engineering Intern: Integration / QA...
Job Summary Apple is currently seeking enthusiastic interns who can work full-time for a minimum of 12-weeks between Fall 2015 and Summer 2016. Our software Read more
Software Engineering Intern: Frameworks at *...
Job Summary Apple is currently seeking enthusiastic interns who can work full-time for a minimum of 12-weeks between Fall 2015 and Summer 2016. Our software Read more
*Apple* Retail - Multiple Positions- Nashua,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions- Napervi...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.