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.

INTRODUCTION

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.]

Disclaimer

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.

CODE RESOURCE PROJECT

Description

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.

Project

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.

Implementation

The code of the main function is as follows:

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

 FlashMain(pp);

 RestoreA4();
}

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;
 GrafPtrport;
 Str255 str, tempStr;

 // First param is flash count.  
 // Convert it to a pascal string
 returnHdl = NewHandle(256L);
 strcpy((char*)str, 
 (char*)*(unsigned char **)paramPtr->params[0]);
 CtoPstr((char*)str);
 
 // Convert the string to a number
 StringToNum(str, &flashCount);
 PtoCstr((char*)str);
 
 // Invert the screen and sound the beep.
 GetPort(&port);
 for (again = 0; again < flashCount; again++) 
 {
 InvertRect(&port->portRect);
 InvertRect(&port->portRect);
 SysBeep(5);
 }
 
 // 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.

STANDALONE APPLICATION

Description

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.

Project

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.

Implementation

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;
 
 theApp->IflApp();
 theApp->XcmdRun();
 theApp->Exit();
}

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)
{
 XCmdPtrparamPtr;
 char   returnStr[1024];
 
 paramPtr = (XCmdPtr)NewPtr(136L); // Size of XCmdBlock.
 GetParams(returnStr);
 
 FillParamPtr(paramPtr, returnStr);
 FlashMain(paramPtr);
 
 DumpData(paramPtr->returnValue);
 // 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);
 theDocument->Dispose();
}

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)
 {
 ++tempPtr;
 while (*tempPtr != 0x22)
 {
 *tokenPtr = *tempPtr;
 ++tempPtr;
 ++tokenPtr;
 }
 ++tempPtr;
 if (*tempPtr == 0x2C)
 ++tempPtr;
 }
 else
 {
 while (*tempPtr != 0x2C)
 {
 *tokenPtr = *tempPtr;
 ++tempPtr;
 ++tokenPtr;
 }
 ++tempPtr;
 }
 *tokenPtr = 0x00;
 theLength = strlen(tokenStr);
 paramPtr->params[count] = NewHandle(theLength + 1);
 strcpy((char*)*(paramPtr->params[count]), tokenStr);
 ++count;
 }
 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;
 
 gBartender->DisableMenuBar();
 theOutput = new BDisplayOutput;
 theOutput->IBDisplayOutput(this, TRUE);
 theOutput->DisplayRun(theData);
 theOutput->Dispose();
}

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.

RESOURCES

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.

RUNNING

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.

FINAL REMARKS

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 ghkenner@cc.utah.edu and AppleLink at UUTL.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Coda 2.5.11 - 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
Bookends 12.5.7 - Reference management a...
Bookends is a full-featured bibliography/reference and information-management system for students and professionals. Access the power of Bookends directly from Mellel, Nisus Writer Pro, or MS Word (... Read more
Maya 2016 - Professional 3D modeling and...
Maya is an award-winning software and powerful, integrated 3D modeling, animation, visual effects, and rendering solution. Because Maya is based on an open architecture, all your work can be scripted... Read more
RapidWeaver 6.2.3 - Create template-base...
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
MacFamilyTree 7.5.2 - Create and explore...
MacFamilyTree gives genealogy a facelift: it's modern, interactive, incredibly fast, and easy to use. We're convinced that generations of chroniclers would have loved to trade in their genealogy... Read more
Paragraphs 1.0.1 - Writing tool just for...
Paragraphs is an app just for writers. It was built for one thing and one thing only: writing. It gives you everything you need to create brilliant prose and does away with the rest. Everything in... Read more
BlueStacks App Player 0.9.21 - Run Andro...
BlueStacks App Player lets you run your Android apps fast and fullscreen on your Mac. Version 0.9.21: Note: Now requires OS X 10.8 or later running on a 64-bit Intel processor. Initial stable... Read more
Tweetbot 2.0.2 - Popular Twitter client....
Tweetbot is a full-featured OS X Twitter client with a lot of personality. Whether it's the meticulously-crafted interface, sounds and animation, or features like multiple timelines and column views... Read more
Apple iBooks Author 2.3 - Create and pub...
Apple iBooks Author helps you create and publish amazing Multi-Touch books for iPad. Now anyone can create stunning iBooks textbooks, cookbooks, history books, picture books, and more for iPad. All... Read more
NeoOffice 2014.12 - Mac-tailored, OpenOf...
NeoOffice is a complete office suite for OS X. With NeoOffice, users can view, edit, and save OpenOffice documents, PDF files, and most Microsoft Word, Excel, and PowerPoint documents. NeoOffice 3.x... Read more

Rage of Bahamut is Giving Almost All of...
The App Store isn't what it used to be back in 2012, so it's not unexpected to see some games changing their structures with the times. Now we can add Rage of Bahamut to that list with the recent announcement that the game is severely cutting back... | Read more »
Adventures of Pip (Games)
Adventures of Pip 1.0 Device: iOS iPhone Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: ** ONE WEEK ONLY — 66% OFF! *** “Adventures of Pip is a delightful little platformer full of charm, challenge and impeccable... | Read more »
Divide By Sheep - Tips, Tricks, and Stre...
Who would have thought splitting up sheep could be so involved? Anyone who’s played Divide by Sheep, that’s who! While we’re not about to give you complete solutions to everything (because that’s just cheating), we will happily give you some... | Read more »
NaturalMotion and Zynga Have Started Tea...
An official sequel to 2012's CSR Racing is officially on the way, with Zynga and NaturalMotion releasing a short teaser trailer to get everyone excited. Well, as excited as one can get from a trailer with no gameplay footage, anyway. [Read more] | Read more »
Grab a Friend and Pick up Overkill 3, Be...
Overkill 3 is a pretty enjoyable third-person shooter that was sort of begging for some online multiplayer. Fortunately the begging can stop, because its newest update has added an online co-op mode. [Read more] | Read more »
Scanner Pro's Newest Update Adds Au...
Scanner Pro is one of the most popular document scanning apps on iOS, thanks in no small part to its near-constant updates, I'm sure. Now we're up to update number six, and it adds some pretty handy new features. [Read more] | Read more »
Heroki (Games)
Heroki 1.0 Device: iOS Universal Category: Games Price: $7.99, Version: 1.0 (iTunes) Description: CLEAR THE SKIES FOR A NEW HERO!The peaceful sky village of Levantia is in danger! The dastardly Dr. N. Forchin and his accomplice,... | Read more »
Wars of the Roses (Games)
Wars of the Roses 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: | Read more »
TapMon Battle (Games)
TapMon Battle 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: It's time to battle!Tap! Tap! Tap! Try tap a egg to hatch a Tapmon!Do a battle with another tapmons using your hatched tapmons! *... | Read more »
Alchemic Dungeons (Games)
Alchemic Dungeons 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: ### Release Event! ### 2.99$->0.99$ for limited time! ### Roguelike Role Playing Game! ### Alchemic Dungeons is roguelike... | Read more »

Price Scanner via MacPrices.net

Canon PIXMA MG3620 Wireless Inkjet All-in-One...
Canon U.S.A., Inc. has announced the PIXMA MG3620 Wireless (1) Inkjet All-in-One (AIO) printer for high-quality photo and document printing. Built with convenience in mind for the everyday home user... Read more
July 4th Holiday Weekend 13-inch MacBook Pro...
Save up to $150 on the purchase of a new 2015 13″ Retina MacBook Pro at the following resellers this weekend. Shipping is free with each model: 2.7GHz/128GB MSRP $1299 2.7GHz/... Read more
27-inch 3.5GHz 5K iMac on sale for $2149, sav...
Best Buy has the 27″ 3.5GHz 5K iMac on sale for $2149.99. Choose free shipping or free local store pickup (if available). Sale price for online orders only, in-store prices may vary. Their price is $... Read more
Apple now offering refurbished 2015 11-inch...
The Apple Store is now offering Apple Certified Refurbished 2015 11″ MacBook Airs as well as 13″ MacBook Airs (the latest models), available for up to $180 off the cost of new models. An Apple one-... Read more
15-inch 2.5GHz Retina MacBook Pro on sale for...
Amazon.com has the 15″ 2.5GHz Retina MacBook Pro on sale for $2274 including free shipping. Their price is $225 off MSRP, and it’s the lowest price available for this model. Read more
Finally Safe To Upgrade To Yosemite’?
The reason I’ve held back from upgrading my MacBook Air from OS X 10.9 Mavericks to 10.10 Yosemite for nearly a year isn’t just procrastination. Among other bugs reported, there have been persistent... Read more
Logo Pop Free Vector Logo Design App For OS X...
128bit Technologies has released of Logo Pop Free 1.2 for Mac OS X, a vector based, full-fledged, logo design app available exclusively on the Mac App Store for the agreeable price of absolutely free... Read more
21-inch 1.4GHz iMac on sale for $999, save $1...
B&H Photo has new 21″ 1.4GHz iMac on sale for $999 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Best Buy has the 21″ 1.4GHz iMac on sale for $999.99 on their... Read more
16GB iPad mini 3 on sale for $339, save $60
B&H Photo has the 16GB iPad mini 3 WiFi on sale for $339 including free shipping plus NY tax only. Their price is $60 off MSRP. Read more
Save up to $40 on iPad Air 2, NY tax only, fr...
B&H Photo has iPad Air 2s on sale for up to $40 off MSRP including free shipping plus NY sales tax only: - 16GB iPad Air 2 WiFi: $489 $10 off - 64GB iPad Air 2 WiFi: $559 $40 off - 128GB iPad Air... Read more

Jobs Board

Global Deployment Project Manager, *Apple*...
…international landscape is paramount to drive innovation, compliance, competition of Apple 's strengths, and talent planning. Manages the process, logistics, and systems Read more
*Apple* MAC Support Services Subject Matter...
Title: Apple MAC Support Services Subject Matter Expert Location: Pleasanton, CA Type of position: Temporary Contract for approximately 6 weeks Tasks The tasks for the Read more
*Apple* MAC Support Administrator - Net2Sour...
…solutions customized to client needs including staffing, training and technology Title Apple MAC Support Administrator Location Belmont, CA Duration 6+ Month Job 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
*Apple* MAC Support Services Subject Matter...
…the best talent to create a competitive advantage. Currently, we are seeking an Apple MAC Support Services Subject Matter Expert for a long term contract in Pleasanton, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.