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

ffWorks 1.0.6 - Convert multimedia files...
ffWorks (was iFFmpeg), focused on simplicity, brings a fresh approach to the use of FFmpeg, allowing you to create ultra-high-quality movies without the need to write a single line of code on the... Read more
Adobe Acrobat 18.011.20035 - Powerful PD...
Acrobat DC is available only as a part of Adobe Creative Cloud, and can only be installed and/or updated through Adobe's Creative Cloud app. Adobe Acrobat DC with Adobe Document Cloud services is... Read more
Adobe Acrobat Reader 18.011.20035 - View...
Adobe Acrobat Reader allows users to view PDF documents. You may not know what a PDF file is, but you've probably come across one at some point. PDF files are used by companies and even the IRS to... Read more
EtreCheck 4.0.3 - For troubleshooting yo...
EtreCheck is an app that displays the important details of your system configuration and allow you to copy that information to the Clipboard. It is meant to be used with Apple Support Communities to... Read more
Yummy FTP Pro 2.0 - $29.99
Yummy FTP Pro is an advanced Mac file transfer app which provides a full-featured professional toolkit combined with blazing speeds and impeccable reliability, so whether you want to transfer a few... Read more
Opera 51.0.2830.34 - 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
Apple iOS 11.2.6 - The latest version of...
iOS 11 sets a new standard for what is already the world’s most advanced mobile operating system. It makes iPhone better than before. It makes iPad more capable than ever. And now it opens up both to... Read more
Google Chrome 64.0.3282.167 - Modern and...
Google Chrome is a Web browser by Google, created to be a modern platform for Web pages and applications. It utilizes very fast loading of Web pages and has a V8 engine, which is a custom built... Read more
Adobe Photoshop CC 2018 19.1.1 - Profess...
Photoshop CC 2018 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). Adobe Photoshop CC 2018, the industry standard... Read more
Apple iOS 11.2.6 - The latest version of...
iOS 11 sets a new standard for what is already the world’s most advanced mobile operating system. It makes iPhone better than before. It makes iPad more capable than ever. And now it opens up both to... Read more

Latest Forum Discussions

See All

Check out these 5 games that are a lot l...
So you're in love with Minecraft, but you're looking for something else to play as well? You've come to the right place then, because this list is all about games that are a bit like Minecraft. Some of them, more than others. [Read more] | Read more »
Our top 5 characters from casual RPG Cre...
Creature Quest definitely lives up to its name with a host of collectible creatures based on fantasy tales and world mythologies. To celebrate Creature Quest’s first birthday, we’re going to lay out what we think are the five best characters in the... | Read more »
Around the Empire: What have you missed...
Did you know that Steel Media has a whole swathe of other sites dedicated to all aspects of mobile gaming? Sure you'll get the very best iPhone news, reviews, and opinions right here at 148Apps, but we don't want you missing out on a single piece... | Read more »
All the best games on sale for iPhone an...
Oh hi there, and welcome to our round-up of the best games that are currently on sale for iPhone and iPad. You thought I didn't see you there, did you, skulking behind the bushes? Trust me though, the bushes aren't where the best deals are. The... | Read more »
The Battle of Polytopia Guide - How to H...
A new update just released for The Battle of Polytopia (formerly Super Tribes), which introduces online multiplayer. For all the fans of Midjiwan’s lite take on Civilization, this is certainly welcome news, but playing online isn’t as easy and... | Read more »
Here are the very best mobile games to p...
It's Valentine's Day! Did you get loads of cards and chocolates and other tacky, simple expressions of human affection? Did you send out tat because you find it almost impossible to express emotion unless there's a section dedicated to it at your... | Read more »
Florence (Games)
Florence 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Florence is an interactive storybook from the award-winning lead designer of Monument Valley about the heart-racing highs and... | Read more »
Purrfect Date (Games)
Purrfect Date 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Cats are a lil’ like marmite. Either you absolutely head-over-heels love’ em, or… nahhh, who are we kidding?! Everyone... | Read more »
More monsters to collect and evolve in C...
A laid-back mix of RPG and TCG, Creature Quest is all about building your deck, evolving your creatures and winning in battle. It’s the creation of VC Mobile, set up by Might and Magic producer Jon Van Caneghem. There are elements of that classic... | Read more »
Check out this awesome hands-on with the...
Well, PlayerUnknown's Battlegrounds has come out on mobile. This isn't a clone, this isn't a riff on the battleroyale mechanics of the game, it's the official mobile port by Tencent. But there's a little bit of a hitch. [Read more] | Read more »

Price Scanner via MacPrices.net

Save up to $350 with these Apple Certified Re...
Apple has a full line of Certified Refurbished iMacs available for up to $350 off original MSRP. Apple’s one-year warranty is standard, and shipping is free. The following models are available: – 27... Read more
B&H offers $200 discount on Silver 15″ Ma...
B&H Photo has Silver 15″ Apple MacBook Pros on sale for $200 off MSRP. Shipping is free, and B&H charges sales tax for NY & NJ residents only: – 15″ 2.8GHz Touch Bar MacBook Pro Silver (... Read more
12″ Apple iPad Pro Sale of the Year! Models u...
B&H Photo has 12″ #iPad Pros on sale for up to $150 off MSRP. Shipping is free, and B&H charges sales tax in NY & NJ only: – 12″ 64GB WiFi iPad Pro: $719 $80 off MSRP – 12″ 256GB WiFi... Read more
Deals on 32GB 9″ iPads: Up to $50 off MSRP, s...
B&H Photo has 2017 9.7″ 32GB iPads on sale for $299 including free shipping plus NY & NJ sales tax only. Their price is $30 off MSRP, and it’s currently the lowest price available for these... Read more
15″ 2.2GHz Retina MacBook Pro available for o...
Apple has Certified Refurbished 15″ 2.2GHz Retina MacBook Pros available for $1699. That’s $300 off MSRP for this model, and it’s the lowest price available for a 15″ MacBook Pro currently offered by... Read more
13″ 3.1GHz/256GB Silver Touch Bar MacBook Pro...
Amazon has the Silver 13″ 3.1GHz/256GB Touch Bar MacBook Pro (MPXX2LL/A) on sale for $1649.99 including free shipping. Their price is $150 off MSRP, and it’s the lowest price available for a new 13″... Read more
Saturday Sale: Amazon offers 13″ 1.8GHz/256GB...
Amazon has the 13″ 1.8GHz/256B Apple MacBook Air on sale today for $250 off MSRP including free shipping: – 13″ 1.8GHz/256GB MacBook Air (MQD42LL/A): $949.99, $250 off MSRP Their price is the lowest... Read more
Roundup of Apple Certified Refurbished 12″ Ma...
Apple has Certified Refurbished 2017 12″ Retina MacBooks available for $200-$240 off the cost of new models. Apple will include a standard one-year warranty with each MacBook, and shipping is free.... Read more
Apple offers Certified Refurbished 10″ and 12...
Apple is now offering Certified Refurbished 2017 10″ and 12″ iPad Pros for $100-$190 off MSRP, depending on the model. An Apple one-year warranty is included with each model, and shipping is free: –... Read more
Apple Canada offers Certified Refurbished Mac...
 Canadian shoppers can save up to $560 on the purchase of a 2017 current-generation MacBook Pro, MacBook, or MacBook Air with Certified Refurbished models at Apple Canada. Apple’s refurbished prices... Read more

Jobs Board

*Apple* Store Leader - Retail District Manag...
Job Description:Job SummaryAs more and more people discover Apple , they visit our retail stores seeking ways to incorporate our products into their lives. It's your Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions - Apple,...
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 - Apple,...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform 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.