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();
}

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Apple iOS 9.3.5 - The latest version of...
iOS is the world’s most advanced mobile operating system, and it’s the foundation of iPhone, iPad, and iPod touch. It comes with a collection of apps and features that let you do the everyday things... Read more
Parallels Desktop 12.0.0 - Run Windows a...
Parallels allows you to run Windows and Mac applications side by side. Choose your view to make Windows invisible while still using its applications, or keep the familiar Windows background and... Read more
Spotify 1.0.36.124. - Stream music, crea...
Spotify is a streaming music service that gives you on-demand access to millions of songs. Whether you like driving rock, silky R&B, or grandiose classical music, Spotify's massive catalogue puts... Read more
Firefox 48.0.2 - Fast, safe Web browser.
Firefox offers a fast, safe Web browsing experience. Browse quickly, securely, and effortlessly. With its industry-leading features, Firefox is the choice of Web development professionals and casual... Read more
BBEdit 11.6.1 - Powerful text and HTML e...
BBEdit is the leading professional HTML and text editor for the Mac. Specifically crafted in response to the needs of Web authors and software developers, this award-winning product provides a... Read more
OmniGraffle Pro 6.6.1 - Create diagrams,...
OmniGraffle Pro helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use... Read more
OmniGraffle 6.6.1 - Create diagrams, flo...
OmniGraffle helps you draw beautiful diagrams, family trees, flow charts, org charts, layouts, and (mathematically speaking) any other directed or non-directed graphs. We've had people use Graffle to... Read more
Dropbox 8.4.21 - Cloud backup and synchr...
Dropbox is an application that creates a special Finder folder that automatically syncs online and between your computers. It allows you to both backup files and keep them up-to-date between systems... Read more
BetterTouchTool 1.84 - 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
ScreenFlow 6.1 - Create screen recording...
ScreenFlow is powerful, easy-to-use screencasting software for the Mac. With ScreenFlow you can record the contents of your entire monitor while also capturing your video camera, microphone and your... Read more

Cartoon Network Superstar Soccer: Goal!!...
Cartoon Network Superstar Soccer: Goal!!! – Multiplayer Sports Game Starring Your Favorite Characters 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Become a soccer superstar with your... | Read more »
Become the King of Avalon in FunPlus’ la...
King Arthur is dead. Considering the legend dates back to the 5th century, it would be surprising if he wasn’t. But in the context of real-time MMO game King of Avalon: Dragon Warfare, Arthur’s death plunges the kingdom into chaos. Evil sorceress... | Read more »
Nightgate (Games)
Nightgate 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: *** Launch Sale: 25% OFF for a limited time! *** In the year 2398, after a great war, a network of intelligent computers known as... | Read more »
3 best fantasy football apps to get you...
Last season didn't go the way you wanted it to in fantasy football. You were super happy following your drafts or auctions, convinced you had outsmarted everyone. You were all set to hustle on the waiver wire, work out some sweet trades, and make... | Read more »
Pokemon GO update: Take me to your leade...
The Team Leaders in Pokemon GO have had it pretty easy up until now. They show up when players reach level 5, make their cases for joining their respective teams, and that's pretty much it. Light work, as Floyd Mayweather might say. [Read more] | Read more »
Ruismaker FM (Music)
Ruismaker FM 1.0 Device: iOS Universal Category: Music Price: $4.99, Version: 1.0 (iTunes) Description: Following up on the success of Ruismaker, here's her crazy twin-sister, designed for people who want to design their own... | Read more »
Space Marshals 2 (Games)
Space Marshals 2 1.0.15 Device: iOS iPhone Category: Games Price: $5.99, Version: 1.0.15 (iTunes) Description: The sci-fi wild west adventure in outer space continues with Space Marshals 2. This tactical top-down shooter puts you in... | Read more »
Dungeon Warfare (Games)
Dungeon Warfare 1.0 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0 (iTunes) Description: Dungeon Warfare is a challenging tower defense game where you become a dungeon lord to defend your dungeon against greedy... | Read more »
Solitairica (Games)
Solitairica 1.0.7 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0.7 (iTunes) Description: Solitairica takes RPG combat and challenging rogue-like progression to a fresh new place—the world of solitaire! | Read more »
Bowmasters tips, tricks and hints
At least for this writer, archery was one of the more pleasant surprises of the 2016 Rio Olympics. As opposed to target shooting with guns, which was dreadfully boring, watching people shoot arrows at targets was pretty darn cool. [Read more] | Read more »

Price Scanner via MacPrices.net

BookBook Releases SurfacePad, BookBook &...
BookBook has released three new covers just for iPad Pro: SurfacePad, BookBook and BookBook Rutledge Edition. BookBook for iPad Pro is a gorgeous leather case reminiscent of a vintage sketchbook.... Read more
Clean Text 1.0 for iOS Reduces Text Cleanup a...
Apimac today announced availability of Clean Text for iOS, a tool for webmasters, graphic designers, developers and magazine editors to reduce text cleanup and editing time, and also for any iPhone... Read more
27-inch iMacs on sale for up to $220 off MSRP
B&H Photo has 27″ Apple iMacs on sale for up to $200 off MSRP including free shipping plus NY sales tax only: - 27″ 3.3GHz iMac 5K: $2099 $200 off MSRP - 27″ 3.2GHz/1TB Fusion iMac 5K: $1899 $100... Read more
Apple refurbished 13-inch MacBook Airs availa...
Apple has Certified Refurbished 2016 and 2015 13″ MacBook Airs now available starting at $849. An Apple one-year warranty is included with each MacBook, and shipping is free: - 2016 13″ 1.6GHz/8GB/... Read more
Apple refurbished iPad mini 2s available for...
Apple is offering Certified Refurbished iPad mini 2s for up to $80 off the cost of new minis. An Apple one-year warranty is included with each model, and shipping is free: - 16GB iPad mini 2 WiFi: $... 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
Mac Pros on sale for $200 off MSRP
B&H Photo has Mac Pros on sale for $200 off MSRP. Shipping is free, and B&H charges sales tax in NY only: - 3.7GHz 4-core Mac Pro: $2799, $200 off MSRP - 3.5GHz 6-core Mac Pro: $3799, $200... Read more
Will We See A 10.5″ iPad Pro in 2017? – The ‘...
A MacRumors report, cites a research note from KGI Securities analyst Ming-Chi Kuo, saying a new size iPad model is in the works. According to the highly respected Cho, who has a strong track record... Read more
IOGEAR USB-C Docking Station Transforms Lapto...
IOGEAR has announced the launch of its innovative USB-C Docking Station with Power Delivery which turns USB-C enabled laptops into desktop workstations. The new IOGEAR USB-C Docking Station features... Read more
12-inch Retina MacBooks on sale for up to $10...
Amazon has 2016 12″ Apple Retina MacBooks on sale for $100 off MSRP. Shipping is free: - 12″ 1.1GHz Space Gray Retina MacBook: $1199 $100 off MSRP - 12″ 1.1GHz Silver Retina MacBook: $1224.99 $75 off... Read more

Jobs Board

*Apple* Professional Learning Specialist - A...
# Apple Professional Learning Specialist Job Number: 51234243 Portland, Maine, Maine, United States Posted: Aug. 18, 2016 Weekly Hours: 40.00 **Job Summary** The Read more
*Apple* Mobile Master - Best Buy (United Sta...
What does a Best Buy Apple Mobile Master do? At Best Buy, our mission is to leverage the unique talents and passions of our employees to inspire, delight, and enrich Read more
*Apple* Retail - Multiple Positions Akron, O...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Simply Mac *Apple* Specialist- Repair Techn...
…The Technician is a master at working with our customers to diagnose and repair Apple devices in a manner that exceeds the expectations set forth by Apple Read more
*Apple* Retail - Multiple Positions Germanto...
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.