XCMD CookBook
| Volume Number: | | 4
|
| Issue Number: | | 6
|
| Column Tag: | | 
|
XCMD CookBook 
By Donald Koscheka, Apple Computer, Inc.
[Donald Koscheka is a Software Engineer employed by Apple Computer Inc. He has written some very important development XCMDs which you will hear about soon. -HyperEd]
Introduction to XCMD’s
If you’ve used Hypercard and its programming language HyperTalk for any length of time, you’ve no doubt discovered some of the things that you can’t do with Hypercard. Perhaps you’re writing a forms generator in HyperTalk and you want to be able to print customized reports. The designers of Hypercard knew that their product would have to be a lot of things to a lot of people and it would be nearly impossible to provide every possible feature in the language. They did, however, provide us with the capability of customizing HyperCard and HyperTalk directly. To paraphrase Abraham Lincoln, “You can fool some of the people all of the time, or all of the people some of the time, but to fool all of the people all of the time, write an XCMD”.
As a programming language, HyperTalk is highly extensible; you can add your own commands and functions to the language very easily. These extensions are known as eXternal CoMmanDs ( XCMDs) and eXternal FunCtioNs (XFCNs). The capital letters, ie. case, are significant as I’ll discuss later. XCMDs and XFCNs are identical at the coding level, so I’ll refer to both as XCMDs. The determination of whether a command will be an XCMD or an XFCN is made at link-time.
Creating an XCMD is a straightforward process. First, you write the XCMD using the language of your choice (I’ll show examples in both “C” and Pascal). Next, you compile and link the XCMD as a resource and then you add it to the resource fork of the stack that you want to call it from, the home stack or even Hypercard itself.
Where you put the XCMD is significant. When Hypercard encounters a command that it does not recognize, it first checks the current object (button or field) to see if it contains any handlers for that command. If no handler is found, the search continues in the following order: card, background, stack, home stack, HyperCard. If after looking in all the places that it could expect to find a handler no handler turns up, Hypercard then searches its own resource fork for any external commands that can handle the command. It identifies the appropriate command by name. Note what this hiearchy implies. If you want your XCMD to be globally visible to all stacks, put the XCMD in HyperCard’s resource fork or Home Card. There is a tradeoff, though. If you want the stack that uses the XCMD to be “portable”, you’ll need to put the XCMD in that stack. There is no conflict of interest here, you can put the XCMD in both places. [Use Rescopy , via scripts, to allow the user the option of installing it into the Home Stack. -HyperEd] Hypercard stops searching as soon as it finds a copy of the command. If it finds a copy in your stack, it’ll stop the search there. If you call the XCMD from another stack that does not contain the XCMD, then it’ll go all the way back to the Home Stack or Hypercard to search for the command.
Now that you have an idea of where to place the XCMD, let’s take a look at how they are created. All XCMDs and XFCNs interface to Hypercard in a standard and straightforward way. When an XCMD is invoked, Hypercard will pass it a parameter block that contains, among other things, the number of parameters and handles to the parameters. For argument’s sake, let’s see how the following XCMD would be called:
Pizza “Cheese”, “Pepperoni”, “Anchovies”
When this XCMD is called, Hypercard will pass a record, referred to as the Parameter Block, to the XCMD. The first argument in the parameter block will be the number of parameters passed; in this case three, one for each item in the argument list. Each parameter is passed as a handle to a zero-terminated text string. Parameter 1 will be a handle to the string “Cheese\0”, where the the ‘\0’ means the character whose ASCII value is 0. “C” programmers will recognize this format as a standard string definition in “C”. Pascal programmers often refer to this format as a C-String. The actual structure of a parameter block (in Pascal) is:
TYPE
XCmdPtr = ^XCmdBlock;
XCmdBlock =
RECORD
paramCount : INTEGER;
params: ARRAY[1..16] OF Handle;
returnValue: Handle;
passFlag : BOOLEAN;
entryPoint : ProcPtr; { to call back to HyperCard }
request : INTEGER;
result: INTEGER;
inArgs: ARRAY[1..8] OF LongInt;
outArgs : ARRAY[1..4] OF LongInt;
END;
Let’s examine this record in more detail. First, we define a pointer to the record, called an XCmdPtr. Hypercard passes a pointer to the record so you’ll need to be comfortable with pointers to work with XCMDs.
The first field in the record, paramCount , is a count of the number of parameters that have been passed to the XCMD. This is a number between 1 and 16, which is the maximum size of the parameter array, params, in field 2. Params is an array of handles which implies that the fundamental element in the array is a signed byte.
Field 3 in the record, returnValue, is a handle to the data that you want to return to Hypercard on completion of the XCMD. You create the handle and pass it back to hypercard with the assignment:
paramPtr^.returnValue := Handle_You_Created;
Herein lies the most important difference between XCMDs and XFCNs. ReturnValue os places in the global container, result, when returning from an XCMD and by value when returning from an XFCN. The following illustrates the mechanics:
XCMD: Pizza “cheese”, “pepperoni”, “anchovies”
Put the result
XFCN: Put Pizza (“cheese”, “pepperoni”, “anchovies”)
XCMDs, like any other command in hypercard, take their parameters on the same line as the command itself. XFCNs, like any other function in Hypercard, take their parameters in parentheses and return a value. This is the most important difference between XCMDs and XFCNs. You make the decision at link-time as to whether a code resource will be an XCMD or an XFCN. Please note, the code is identical for both XCMDs and XFCNs. Hypercard re-vectors ReturnValue for you depending on whether you invoked an XCMD or an XFCN.
The next field, passFlag, should be set to TRUE if you want Hypercard to pass the command on in the hierarchy after invoking the XCMD. Most of the time, you won’t concern yourself with this field.
The next five fields in the parameter block are used for making callbacks to Hypercard [the subject of the next article -DK]. Callbacks allow you to invoke some hypercard commands from within an XCMD, quite a useful feature. An example of a callback is GetFieldByNum which will return a handle to the data in a field on the current card. This is analogous to “Get card field 1” in HyperTalk.
EntryPoint is set by Hypercard on entry to the XCMD and is used as a jumping off point for invoking callbacks. In effect, Hypercard will execute a jump instruction to EntryPoint for all callbacks. But before executing the jump instruction, Hypercard will place an integer value into the Request field. This integer tells Hypercard which callback to execute. The code at entryPoint will vector to the appropriate routine based on the value in Request.
Upon returning from a callback, Hypercard will have set the value of the Result field to some integer value to tell you how things went in the callback. A value of 0 indicates that no error occurred in the callback, 1 indicates that the callback failed for some reason or other and 2 indicates that the callback is not implemented.
The next to last field in the record, inArgs, is an array of up to eight input arguments to the callback. Although the arguments are passed as longInts (long in “C”), they may contain anything. Generally speaking, the Hypercard callback glue will handle type-casting for you.
Finally, callbacks can return up to 4 parameters in OutArgs. These parameters will be set by the callback and available to you from the calling XCMD. Callbacks are glued to the XCMD using standard Pascal interfaces so they’re pretty easy to get along with.
Callbacks are a useful and powerful tool available to the XCMD programmer. Currently, Hypercard includes about thirty callbacks and I’ll discuss each one in more detail next month.
The foregoing discussion implies that you’ll mostly concern yourself with the first four fields in the record and let Hypercard manage the callback parameters. In practice, you’ll mostly be concerned with paramCount, params and returnValue.
For the sake of our “C” readership, here’s the definition of the parameter block as a “C” structure:
typedef struct XCmdBlock {
short paramCount;
Handle params[16];
Handle returnValue;
BooleanpassFlag;
char *entryPoint;
shortrequest;
short result;
longinArgs[8];
long outArgs[4];
} XCmdBlock, *XCmdBlockPtr;
All Input and Output to an XCMD is passed through the parameter block. Armed with this information, here is a simple XCMD that does absolutely nothing (note: I use MPW Pascal and “C” in my examples).
{******************************************* *}
{* File: SimpleXCMD.p*}
{* *}
{* Shell for XCMDs and XFCNs in MPW Pascal *}
{* -------------------------------------- *}
{* In: paramPtr = pointer to the XCMD *}
{* Parameter Block *}
{* *}
{* -------------------------------------- *}
{* © 1988, Donald Koscheka*}
{* -------------------------------------- *}
{******************************************* *}
(******************************
BUILD SEQUENCE
pascal SimpleXCMD.p
link -m ENTRYPOINT -rt XCMD=6555
-sn Main=SimpleXCMD
SimpleXCMD.p.o
“{Libraries}”Interface.o
“{PLibraries}”Paslib.o
-o “{xcmds}”your_stack_here
******************************)
{$S SimpleXCMD }
UNIT Donald_Koscheka;
INTERFACE
USES
MemTypes, QuickDraw, OSIntf, ToolIntf,
PackIntf, HyperXCmd;
PROCEDURE EntryPoint( paramPtr: XCmdPtr);
IMPLEMENTATION
{$R-}
TYPE
Str31 = String[31];
PROCEDURE SimpleXCMD(paramPtr: XCmdPtr); FORWARD;
{--------------EntryPoint----------------}
PROCEDURE EntryPoint(paramPtr: XCmdPtr);
BEGIN
SimpleXCMD(paramPtr);
END;
{----------SimpleXCMD------------------}
PROCEDURE SimpleXCMD(paramPtr: XCmdPtr);
VAR
i : INTEGER;
{$I XCmdGlue.inc }
BEGIN
WITH paramPtr^ DO
BEGIN
returnValue := NIL;
END;
END;
END.
The Build sequence for this file is included in the header for the sake of convenience. After the compilation, we need to link the code into a resource and add it to some stack. First, let’s take a closer look at the link options. The “-m ENTRYPOINT” option tells the linker that the first line of executable code in the resource is at the label ENTRYPOINT. Next, the “-rt XCMD=6555” option tells the linker that this file whould be written as a resource of type “XCMD” and should be assigned a resource ID of 6555. Because we are writing the resource directly out to the stack named “your_stack_here”, any XCMD with ID 6555 will be overwritten by this link. To link the code as an XFCN, use “-rt XFCN=6555”. That’s about the only difference between XCMDs and XFCNs!
You must remember to note that resource types are case sensitive. Telling the linker to set the resource type to “xcmd” will work fine, only Hypercard won’t recognize the resource as an XCMD. As far as numbering XCMDs goes, I don’t know of any rational system that’s been implemented yet. Follow the number guidelines provided in Inside Macintosh, Chapter five.
The option “-sn Main=SimpleXCMD” tells the linker to change the segment name of the main segment from “Main” to “SimpleXCMD”. “SimpleXCMD.p.o” is the name of the input file, the library includes follow. The last line “-o your_stack_here” instructs the linker to add this XCMD to the resource fork of the stack whose name is “your_stack_here”. Remember to include pathnames in your build.
The build sequence for XCMDs is pretty much a boiler-plate. You’ll change type from XCMD to XFCN, the ID to whatever you want, and the input and output lines. About the most important addition you might make to the build is to add libraries as needed.
The XCMD itself follows the standard layout for a Pascal Unit. The unit name is inconsequential to us. A lot of programmers use “UNIT dummyUnit” to remind themselves of that . I use my name instead.
The interface portion is straightforward. Tell the compiler what files you want to include and declare the interface to your routine. Note that we use “EntryPoint” and not “SimpleXCMD” as the main entrypoint for this routine. I’ll leave it as an exercise to the student to figure what that’s all about.
Note the use of the {$R-} directive in the implementation section. This turns off range checking and results in more efficient code. Although we don’t use the Str31 type declared in the TYPE statement, it is needed by the callbacks so we MUST include it here.
Procedure SimpleXCMD contains the actual code for the XCMD. Note that it takes exactly one parameter, a pointer to an XCmdBlock. Although the VAR statement is not used in the body of the code, I included it here so that those of you that are less fluid in Pascal can clearly see that the {$I XCmdGlue.inc} directive follows the CONST, TYPE and VAR declarations within SimpleXCMD. XCMDGlue contains the glue routines for the callbacks. They are simple compiled with the rest of the code. Because of the scoping of procedures feature of Pascal, the glue routines will be able to access paramPtr directly, you won;t need to pass it to each routine in turn.
Finally, the body of the program. Here we simply set the returnValue to NIL and exit. If you already have code that you want to implement in an XCMD or XFCN, replace the body of SimpleXCMD with the body of your routine and off you go!
PROCEDURE SimpleXCMD(paramPtr: XCmdPtr);
VAR
i : INTEGER;
{$I XCmdGlue.inc }
BEGIN
WITH paramPtr^ DO
BEGIN
returnValue := NIL;
END;
END;
XCMDs in “C” are different enough in implementation to bear some discussion. Here is SimpleXCMD in “C”:
/*************************************** *\
*file: SimpleXCMD.c *
**
* XCMD shell in MPW “C” *
**
*C -q2 SimpleXCMD.c*
*link -sn Main=SimpleXCMD *
*-sn STDIO=SimpleXCMD *
*-sn INTENV=SimpleXCMD -rt XCMD=301 *
* SimpleXCMD.c.o -o your_stack_here *
**
*If you use parts of the “C” *
*Library, use this *
*link instead: *
**
*link -sn Main=SimpleXCMD -sn *
*STDIO=SimpleXCMD *
* -sn INTENV=SimpleXCMD -rt XCMD=301*
* -m SIMPLEXCMD SimpleXCMD.c.o *
*“{CLibraries}”CRuntime.o *
*“{CLibraries}”CInterface.o *
*-o your_stack_here*
**
* ------------------------------------ *
* By: Donald Koscheka*
* Date: 21-Sept-87 *
* ©Copyright 1987, Donald Koscheka *
**
* ------------------------------------ *
\**********************************/
#include<Types.h>
#include<OSUtils.h>
#include<Memory.h>
#include<Files.h>
#include<Resources.h>
#include “HyperXCmd.h”
pascal void SimpleXCMD( paramPtr )
XCmdBlockPtr paramPtr;
/*******************************
* SimpleXCMD()
*******************************/
{
paramPtr->returnValue = nil;
}
#include <XCmdGlue.inc.c>
SimpleXCMD() is defined as a Pascal Void to tell the “C” compiler to push the parameters “Pascal Style”. This means that parameters are pushed from left to right rather than from right to left. Also, we need to inform “C” that this function does not return a value, so we qualify the type with “void”. Otherwise, “C” will leave room on the stack for an integer-wide return value.
An important difference between the two languages is that “C” does not allow scoping of procedures. The callback glue routines are not local to SimpleXCMD as is the case in Pascal. For this reason, when calling glue routines from “C”, the first parameter passed must be a pointer to the XCmdBlock.
When you start programming XCMDs, you may encounter a seemingly nebulous link error, “No Data Initialization”. The linker is telling you that there is no global memory to initialize for the XCMD. XCMDs are code resources, they are designed to be called “subroutine” fashion from Hypercard and as such do not have access to their own globals. Put another way, Hypercard owns the global pool from which XCMDs may draw. This means that the only kind of data that can be declared in an XCMD is local data, also known as automatics. Automatics get created on the stack and exist only for the life of the XCMD. When the XCMD returns to Hypercard, the local memory pool goes away.
You are most likely to encounter a problem with this when using strings in “C”. Consider the following code fragment:
char *myStr;
myStr = “Colleen”;
In this code, I declare a string pointer called myStr. I then point this string pointer at the properly formed string ‘Colleen’. This code will compile correctly but the linker will not be able to work with it. When “C” compiles strings in-line, it actually puts the string into the global pool and points myStr at the string in global memory. Since the XCMD is assembled without global memory, the linker won’t know what to do with this code. Pascal does not suffer this fate because it does not put the string into global memory. The following code will compile and link just fine in Pascal:
myStr : StrPtr;
myStr := ‘Margaret’;
The reason this works in Pascal and not in “C” is that Pascal tacks the string “Margaret” onto the end of the code resource, rather than put the string into global memory.
The upshot of this diatribe is don’t declare global variables from XCMDs. If you need to use strings in “C”, you’ll need to hard-code the assignments:
myStr[0] = ‘C’;
myStr[1] = ‘o’;
myStr[2] = ‘l’;
myStr[3] = ‘l’;
myStr[4] = ‘e’;
myStr[5] = ‘e’;
myStr[6] = ‘n’;
myStr[7]= ‘\0’
If your going to be using a lot of strings, I would suggest that you either put them in resources (yuck!) or use Pascal instead.
This article presented the basics of XCMD programming and describes how to interface your code to Hypercard. Next month I’ll introduce the callbacks and give some examples how they can make XCMD programming easier and more fun. If you’re already an experienced Macintosh programmer, the above is information enough to get you started on XCMDs. If you’re just getting started, this article should be just enough to help you get started, without being too much, to get you lost.
