TweetFollow Us on Twitter

XCMD ANSI Library
Volume Number:6
Issue Number:6
Column Tag:Programmer's Forum

XCMD ANSI Library

By Gerry H. Kenner, David Burggraaf, Salt Lake City, UT

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

XCMD ANSI Library

[Gerry Kenner is a conservative senior citizen who has been working with computers and writing scientific papers since 1962 when the era first began. David Burggraaf is a newcomer to the field who got his first computer (a Sinclair) in 1980 and hasn’t stopped being excited since. Suffice it to say that most of the ideas and all of the work involved in this project were done by David.]

With their fixed methods of entering, retrieving and manipulating data, code resource packages appear to be the ideal system of object oriented programming. In this case, the object is the code resource. The popularity of this concept is shown by the use of code resources under different names by 4th Dimension™(external objects), Excel™ (DDLs) and Hypercard™ (XCMDs and XFCNs). Further, pioneer systems for using code resources in standalone programs are becoming available, the first example being Serius89™ but other programs are not far behind.

A problem with this type of programming is that the libraries must be replicated whenever they are used in different code resources. Further, when doing code resources at least some compilers link in all functions in a library and not just the ones being used. This is in contrast to the smart linking which occurs when standalone applications are generated. Experience has shown us that the size of most code resources can be reduced by 50% while some can be reduced by as much as 70% or more if the library routines are removed.

This paper reports on a method for installing the libraries and a jump table to access them as a separate code resources and then using a simple series of calls to access them from other code resources (Hypercard XCMDs in this case).

The Project

The project consisted of putting all the library functions in two code resources of type “LIB “ called CodeLib and FCodeLib. Two code resources were used because the dispatch routines for functions which return arguments longer than 32 bits are different from the cases where the return value will fit in register D0. Included in each library is the code of the library functions and a dispatch routine (main()) to provide access to them. The “LIB “ type resources are loaded into Hypercard or stacks using ResEdit.

The .h file

The CodeLib.h file includes the necessary definitions and macros for setting up the libraries in XCMD projects. Included are the list of index variables for each function call (i.e., CLatoi, CLatol, etc.), macro definitions for redefining return parameters and library function call names (#define atoi(str) ((**idispatch) (CLatoi,(char*)(str))), and typedef void (**Vfunch) (CodeLib,...);, etc.) and the macro calls which are added to the XCMD project for incorporating the above material in source code.

Perhaps the best method for understanding the contents of this file is to follow the compilation and execution of the main routine of the XCMD following the addition of the special library code. First of all, the contents of CodeLib.h are read in. In addition to declaring the macros and index variables, this file defines the handles VFunch, IFunch, etc and declares extern global variables of these types (dispatch, idispatch, etc). When executed the macro CODELIB legitimitizes the extern declaration of these variables by declaring them within the XCMD.

LOADCODELIB() is a function which appears as follows when unfolded.

/* 1 */

LOADCODELIB()
if (!initCodeLib())
 return;
else
 HLock(dispatch);
if (!initFCodeLib())
 HUnlock(dispatch);
 return;
else
 HLock(ddispatch);

Its function is to determine whether the libraries are present, get handles to them and then lock the handles so the libraries won’t move. Otherwise it returns with nothing being done. The task of getting the handles is done by initCodeLib() and initFCodeLib. The initCodeLib macro is expanded to show how this is done.

/* 2 */

initCodeLib()
fdispatch = (Ffunch)GetResource(‘LIB ‘, 18000);
pdispatch = (Pfunch)fdispatch;
cdispatch = (Cfunch)pdispatch;
ldispatch = (Lfunch)cdispatch;
idispatch = (Ifunch)ldispatch;
dispatch = (Vfunch)idispatch;

Note that all the handles point to the same address.

With the above code in place, execution of a code line such as

/* 3 */

 TempInt = atoi(TempStr);

will result in the following at compilation time.

/* 4 */

 TempInt = ((**idispatch)(CLatoi, (char*)TempStr)));

When executed, this code will pass the address of idispatch, the value of the index CLatoi and the contents of TempStr to the library code resource.

A Special Case

An exception to the above ease of use are function calls such as sprintf which pass variable numbers of arguments. In these cases, the definitions in the CodeLib.h file serve as templates for inserting the code manually. For instance, the definition of sprintf(s,f) is ((**idispatch)(CLsprintf, (s), (f), ...)). When a statement such as sprintf(TempStr, “Good Day”) is encountered the programmer must replace it manually with ((**idispatch) (CLsprintf, TempStr, “Good Day”) using the definition as a guide.

CodeLibDispatch.c

This file shares the CodeLib.h file except it does not include the NOCODELIB definitions for redefining the library function call names. Addressing the library functions is taken care of by declaring the following code before the main routine is called.

/* 5 */

typedef void (*Function)(void);
FunctionfuncTable[ROUTINES + 1]

where the value of ROUTINES was declared in CodeLib.h. Values are assigned to the funcTable variable within the main routine as follows.

/* 6 */

funcTable[CLdispatchErr]=dispatchErr;
funcTable[CLatoi]=(Function)atoi;
funcTable[CLatol]=(Function)atol;
funcTable[CLsprintf]=(Function)sprintf;
funcTable[CLsrand]=(Function)srand;
funcTable[CLstrcpy]=(Function)strcpy;

It would be nice if these could be declared statically, but we have not been able to figure out a method for doing it.

There are two segments of assembly language code. The first segment replaces the calls RememberA4() and SetUpA4() which are not used because they shift things around on the stack. This code stores the current value of A4 and replaces it with the address of the main routine which is stored in A0 when the code is called. The second assembly language segment is a glue routine for configuring the stack before jumping to the desired library function.

/* 7 */

 asm  {
 move.l (a7)+, returnAddr;/*save return address*/
 move.w (a7)+, a1; /*remove index*/
 lea funcTable, a0;/*do jump to indexed subroutine*/
 jsr ([0,a0,a1.w*4],0);
 move.w a1, -(a7); /*restore stack and return*/
 move.l returnAddr, -(a7);
 move.l oldA4, a4; /*restore a4  */
 }

It removes the return address and saves it before doing a jsr to the requested funcTable entry after which it is put back on the stack. The index value is also removed from the stack, placed in a1 for use as an offset and then replaced on the stack at the end of the call. The last line of code restores the old value of a4.

General

Note that there are six dispatch types although only four are used in this code. The remaining two are for functions which return floats and structures. Further functions can be added to by using the formats given. We have included the code of a sample Hypercard XCMD which uses the libraries or of a Hypercard stack to exercise the XCMD. Other examples are left as an exercise for the reader.

This project is written with THINK C. Similar code would be difficult though possible to implement in Pascal. An important point to note if you are using calls which use floating point arithmetic or call the printf type functions is that the standard ANSI-A4 library does not include floating point functions nor math functions. The math functions are gained by adding math.c to the ANSI-A4 library project. Floating point capabilities are added by opening the ansi-config.h file which is found in the source code of the ANSI-A4 project and commenting out the line #define _NOFLOATING_ and then recompiling the project under a different name such as ANSI-A4(f). Another point to remember is that other functions such as qsort and atof are also not part of the ANSI-A4 project and must be added if they are to be used.

If you have any questions David can be reached on internet at BURGGRAAF @ cc.utah.edu.

Installation Instructions:

1. Install the Library code resource wherever it is needed, i.e., as a code resource in your Hypercard stack.

2. Include the “CodeLib.h” header file before any of the functions in the code library are called.

3. Enter the line

CODELIB;

before any function in the library is called. It must be typed outside of any function. It is a preprocessor declaration of the necessary global variables.

4. If they are not already part of your code put in the instructions RememberA0, SetUpA4 and RestoreA4, so that the above global variables can be used.

5. In the main function, at the beginning type the line.

LOADCODELIB();

This should be the first function call other than functions which setup registers for global variable access. (i.e., SetupA4()).

6. In the main function, at the end enter the line.

UNLOADCODELIB();

7. If present, remove any duplicate libraries which are present in your project.

8. Build the project.

Listing:  CodeLib.h

#ifndef _CODE_LIB_
#define _CODE_LIB_
typedef enum
 {
 CLdispatchErr=0,
 CLatoi,
 CLatol,
 CLsprintf,
 CLsrand,
 CLstrcpy,
 CLsqrt=1 /*Double/struct lib */
 } CodeLib;

#define ROUTINES 5
#define FROUTINES  1

#ifndef NOCODELIBDEF
#define atoi(str) ((**idispatch)(CLatoi,(char *)(str)))
#define atol(str) ((**ldispatch)(CLatol,(char *)(str)))
#define sprintf(s,f) ((**idispatch)(CLsprintf,(s),(f),...))
#define srand(s) ((**dispatch)(CLsrand,(unsigned)(s)))
#define strcpy(s1,s2) ((char *)((**pdispatch)(CLstrcpy,(char*)(s1),(char 
*)(s2))))
#define sqrt(d) ((**ddispatch)(CLsqrt, (double)(d)))
#endif NOCODELIBDEF

typedef void (**Vfunch)(CodeLib,...);
typedef int (**Ifunch)(CodeLib,...);
typedef long (**Lfunch)(CodeLib,...);
typedef char (**Cfunch)(CodeLib,...);
typedef float (**Ffunch)(CodeLib,...);
typedef double (**Dfunch)(CodeLib,...);
typedef void *(**Pfunch)(CodeLib,...);

#define CODELIB Vfunch dispatch;Ifunch idispatch;Lfunch ldispatch;Cfunch 
cdispatch;Ffunch fdispatch;Dfunch ddispatch;Pfunch pdispatch;
#ifndef NOTLLIB
#define initCodeLib() (dispatch=(Vfunch)(idispatch=(Ifunch)(ldispatch=(Lfunch)(cdispatch=( 
Cfunch)(pdispatch=(Pfunch)(fdispatch=(Ffunch)GetResource(‘LIB ‘, 18000)))))))
#else
#define initcodeLib() 1
#endif CODELIB

#ifndef NOFLOATLIB
#define initFCodeLib() (ddispatch=(Dfunch)GetResource(‘LIB ‘, 18001))
#else
#define initFCodeLib() 1
#endif NOFLOATLIB

#define LOADCODELIB() {if (!initCodeLib()) return;else HLock(dispatch);if 
(!initFCodeLib()) {HUnlock(dispatch);return;}else HLock(ddispatch);}
#define UNLOADCODELIB() {HUnlock(dispatch);HUnlock(ddispatch);}

extern Vfunch dispatch;
extern Ifunch idispatch;
extern Lfunch ldispatch;
extern Cfunch cdispatch;
extern Ffunch fdispatch;
extern Dfunch ddispatch;
extern Pfunch pdispatch;
#endif
Listing:  CodeLibDispatch.c

#include <stdio.h>
#include <string.h>
#include <stdlib.h>

#define NOCODELIBDEF
#include “CodeLib.h”

typedef void (*Function)(void);

long returnAddr, oldA4;
int funcIndex;
void dispatchErr(void);
Function funcTable[ROUTINES+1];
 
void main(void)
 { /* CodeLib routine*/
 asm  {
 move.l a4, a1;  /*setup a4 */
 move.l a0, a4;
 move.l a1, oldA4;
 };
 funcTable[CLdispatchErr]=dispatchErr;
 funcTable[CLatoi]=(Function)atoi;
 funcTable[CLatol]=(Function)atol;
 funcTable[CLsprintf]=(Function)sprintf;
 funcTable[CLsrand]=(Function)srand;
 funcTable[CLstrcpy]=(Function)strcpy;
 asm  {
 move.l (a7)+, returnAddr;/*save return address*/
 move.w (a7)+, a1; /*remove index  */
 lea funcTable, a0;/*do jump to indexed subroutine*/
 jsr ([0,a0,a1.w*4],0);
 move.w a1, -(a7); /*restore stack and return*/
 move.l returnAddr, -(a7);
 move.l oldA4, a4; /*restore a4  */
 }
 UnloadA4Seg(0L);
 } /* Main*/

void dispatchErr(void)
 {
 SysBeep(5);
 }
Listing:  FCodeLibDispatch.c

#include <math.h>

#define NOCODELIBDEF
#include “CodeLib.h”

typedef void (*Function)(void);

long returnAddr, oldA4, returnStruct;
int funcIndex;
void dispatchErr(void);
Function funcTable[FROUTINES+1];
 
void main(void)
 { /*CodeLib routine*/
 asm  {
 move.l a4, a1;  /*setup a4 */
 move.l a0, a4;
 move.l a1, oldA4;
 };
 funcTable[CLdispatchErr]=dispatchErr;
 funcTable[CLsqrt]=(Function)sqrt;
 asm  {
 move.l (a7)+, returnAddr;/*save return address*/
 move.l (a7)+, returnStruct;/*save return StructPtr*/
 move.w (a7)+, a1; /*remove index  */
 move.l returnStruct, -(a7);/*put return StructPtr*/
 lea funcTable, a0;/*do jump to indexed subroutine*/
 jsr ([0,a0,a1.w*4],0);
 move.l (a7)+, returnStruct;/*get return structPtr*/
 move.w a1, -(a7); /*restore stack and return*/
 move.l returnStruct, -(a7);
 move.l returnAddr, -(a7);
 move.l oldA4, a4; /*restore a4  */
 }
 UnloadA4Seg(0L);
 } /* Main*/

void dispatchErr(void)
 {
 SysBeep(5);
 }

Listing: testCodeLib.c

#include “CodeLib.h”
#include “HyperXCmd.h”
#include “SetUpA4.h”

CODELIB;

pascal void main(XCmdBlockPtr paramPtr)
{
 int    TempInt1, TempInt2;
 unsigned int  Seed;
 long   TempLong;
 StringHandle  TempHdl;
 double TempDouble1, TempDouble2;
 Ptr    TempPtr;
 Str255 TempStr;
 
 RememberA0();
 SetUpA4();
 LOADCODELIB();
 TempHdl = (StringHandle)NewHandle(256);
 TempPtr = *(paramPtr->params[0]);
 TempInt1 = atoi((char*)TempPtr);
 TempPtr = *(paramPtr->params[1]);
 TempLong = atol((char*)TempPtr);
 TempInt2 = (int)TempLong;
 TempInt1 = TempInt1 * TempInt2;
 TempDouble2 = (double)TempInt1;
 TempDouble1 = sqrt(TempDouble2);
 Seed = (unsigned int)TempDouble1;
 srand(Seed);
 (**idispatch)(CLsprintf,TempStr, “The square root of %d is %.2g.”,
 TempInt1, TempDouble1);
 strcpy(*TempHdl, TempStr);
 paramPtr->returnValue = (Handle)TempHdl;
 
 UNLOADCODELIB();
 RestoreA4();
}

 
AAPL
$101.66
Apple Inc.
+0.23
MSFT
$46.70
Microsoft Corpora
-0.31
GOOG
$575.62
Google Inc.
-5.73

MacTech Search:
Community Search:

Software Updates via MacUpdate

Screenshot Path 1.2.1 - Change the defau...
Screenshot Path lets you change the folder where OS X saves screenshots. Screenshots are saved by default to the user’s desktop. This is handy for the occasional screenshot but those looking to take... Read more
Fantastical 1.3.16 - Create calendar eve...
Fantastical is the Mac calendar you'll actually enjoy using. Creating an event with Fantastical is quick, easy, and fun: Open Fantastical with a single click or keystroke Type in your event details... Read more
GIMP 2.8.14 - Powerful, free image editi...
GIMP is a multi-platform photo manipulation tool. GIMP is an acronym for GNU Image Manipulation Program. The GIMP is suitable for a variety of image manipulation tasks, including photo retouching,... Read more
HoudahSpot 3.9.3 - Advanced front-end fo...
HoudahSpot is an advanced file search tool built upon MacOS X Spotlight. Spotlight unleashed Create detailed queries to locate the exact file you need Narrow down searches. Zero in on files Save... Read more
djay 4.2.3 - Transform your Mac into a f...
djay transforms your Mac into a full-fledged DJ system, allowing you to mix your iTunes music library on a hyper-realistic turntable interface. Perform live, record mixes on-the-go, or enable... Read more
iDefrag 2.2.8 - Disk defragmentation and...
iDefrag helps defragment and optimize your disk for improved performance. Features include: Supports HFS and HFS+ (Mac OS Extended). Supports case sensitive and journaled filesystems. Supports... Read more
Bookends 12.2.3 - 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
Copy 1.47.0410 - Cloud storage and file...
Note: You must first sign up to use Copy (get a 5GB sign-up bonus through our 'Download' link above). Copy lets you sync, protect, and share. Everywhere. Want to bring some files home? No problem!... Read more
Stacks 2.6.3 - New way to create pages i...
Stacks is a new way to create pages in RapidWeaver: A plugin designed to combine drag-and-drop simplicity with the power of fluid layout. Features: Fluid Layout: Stacks lets you build pages that... Read more
RestoreMeNot 2.0 - Disable window restor...
RestoreMeNot provides a simple way to disable the window restoration for individual applications so that you can fine-tune this behavior to suit your needs. Please note that RestoreMeNot is designed... Read more

Latest Forum Discussions

See All

This Week at 148Apps: September 8-12, 20...
Expert App Reviewers   So little time and so very many apps. What’s a poor iOS devotee to do? Fortunately, 148Apps is here to give you the rundown on the latest and greatest releases. And we even have a tremendous back catalog of reviews; just check... | Read more »
Rejoice, Kittens! Kitty Powers’ Matchmak...
Rejoice, Kittens! | Read more »
Upcoming Digital Board Game SettleForge...
Upcoming Digital Board Game SettleForge is Headed to iOS Posted by Jessica Fisher on September 12th, 2014 [ permalink ] SettleForge is a single-player board game where players take on the role of the king as they try to | Read more »
Air Supply SOS Set to Bring Retro Sheep...
Air Supply SOS Set to Bring Retro Sheep Rescuing to iOS Soon Posted by Ellis Spice on September 12th, 2014 [ permalink ] Quantum Sheep has announced that the latest entry in the | Read more »
Star Wars: Commander Reveals Who is Winn...
Star Wars: Commander Reveals Who is Winning the Galactic Civil War Posted by Jessica Fisher on September 12th, 2014 [ permalink ] Disney Interactive has released a new infographic detailing the stat | Read more »
The New MOGA REBEL iOS Controller is Set...
The New MOGA REBEL iOS Controller is Set to Be Released on September 17 Posted by Jessica Fisher on September 12th, 2014 [ permalink ] MO | Read more »
Scuba Dupa Review
Scuba Dupa Review By Rob Thomas on September 12th, 2014 Our Rating: :: BUBBLE TROUBLEUniversal App - Designed for iPhone and iPad Scuba Dupa is cute and simple fun, but you’re going to have to part with a bit too much sunken... | Read more »
Get Ready for the iPhone 6 – Amazon Trad...
Get Ready for the iPhone 6 – Amazon Trade-in Program Locks in Used Gadget Prices Until October 10 Posted by Ellis Spice on September 12th, 2014 [ permalink ] | Read more »
Kings of the Realm Review
Kings of the Realm Review By Jennifer Allen on September 12th, 2014 Our Rating: :: STANDARD BASE BUILDINGUniversal App - Designed for iPhone and iPad Kings of the Realm offers some handy tweaks, but it’s still the familiar format... | Read more »
Five Nights at Freddy's (Games)
Five Nights at Freddy's 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: NOTE: It's recommended to have at least 512 megs of ram on your device, low-memory devices may crash during gameplay.... | Read more »

Price Scanner via MacPrices.net

More To Making A Larger iPad Than Expanded Sc...
CNET’s Ross Rubin has posted a thoughtful analysis of prospects for a larger display iPad Pro, noting that Microsoft and Samsung currently have the large-display touchscreen tablet category to... Read more
SwiftKey Keyboard Finally Coming To iPhone An...
At the TechCrunch Disrupt event in San Francisco, Swiftkey unveiled the first details about SwiftKey Keyboard for iPhone, iPad & iPod touch. SwiftKey’s philosophy is that you should be able to... Read more
Save $75 on the 16GB iPad mini with Retina Di...
Best Buy has the 16GB iPad mini with Retina Display on sale for $324.99 on their online store for a limited time. Their price is $75 off MSRP, and it’s the lowest price available for this mini.... Read more
21-inch 1.4GHz iMac on sale for $979, $120 of...
B&H Photo has the new 21″ 1.4GHz iMac on sale for $979.99 including free shipping plus NY sales tax only. Their price is $120 off MSRP. B&H will also include free copies of Parallels Desktop... Read more
Apple restocks refurbished 21-inch 1.4GHz iMa...
The Apple Store has restocked Apple Certified Refurbished 21″ 1.4GHz iMacs for $929 including free shipping plus Apple’s standard one-year warranty. Their price is $170 off the cost of new models,... Read more
13-inch 2.6GHz/256GB Retina MacBook Pro on sa...
Adorama has the 13″ 2.6GHz/256GB Retina MacBook Pro on sale for $1379 including free shipping plus NY & NJ sales tax only. Their price is $120 off MSRP, and it’s the lowest price available for... Read more
Macally iPhone 6 Cases
Macally has introduced a Line of Snap-On Shell Cases, Frame Bumper Cases and a Rugged Protective Case for iPhone 6 with 4.7inch Screen, such as the SNAP case in a variety of brilliant metallic... Read more
Belkin Launches New Accessories iPhone 6 and...
Belkin has unveiled a new collection of products for iPhone 6 and iPhone Plus. Belkin’s new iPhone 6 and iPhone 6 Plus accessories include athletic-inspired armbands, classic phone cases and advanced... Read more
Skinit Debuts Customizable Apple iPhone 6 Cas...
Skinit, pioneer creators of protective personalized solutions for consumer electronic devices, has introduced its new collection of customizable Skinit cases and skins for the new Apple iPhone 6.... Read more
Apple refurbished MacBook Pros available for...
The Apple Store has Apple Certified Refurbished 13″ and 15″ MacBook Pros available starting at $929. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.5GHz MacBook Pros (4GB RAM/... 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
*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
*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
*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
*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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.