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

BBEdit 11.6.4 - 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
beaTunes 4.6.12 - Organize your music co...
beaTunes is a full-featured music player and organizational tool for music collections. How well organized is your music Library? Are your artists always spelled the same way? Any R.E.M. vs REM?... Read more
Tinderbox 7.0.1 - Store and organize you...
Tinderbox is a personal content management assistant. It stores your notes, ideas, and plans. It can help you organize and understand them. And Tinderbox helps you share ideas through Web journals... Read more
FotoMagico 5.4 - Powerful slideshow crea...
FotoMagico lets you create professional slideshows from your photos and music with just a few, simple mouse clicks. It sports a very clean and intuitive yet powerful user interface. High image... Read more
Direct Mail 4.3.9 - Create and send grea...
Direct Mail is an easy-to-use, fully-featured email marketing app purpose-built for OS X. It lets you create and send great looking email campaigns. Start your newsletter by selecting from a gallery... Read more
Tinderbox 7.0.1 - Store and organize you...
Tinderbox is a personal content management assistant. It stores your notes, ideas, and plans. It can help you organize and understand them. And Tinderbox helps you share ideas through Web journals... Read more
Direct Mail 4.3.9 - Create and send grea...
Direct Mail is an easy-to-use, fully-featured email marketing app purpose-built for OS X. It lets you create and send great looking email campaigns. Start your newsletter by selecting from a gallery... Read more
FotoMagico 5.4 - Powerful slideshow crea...
FotoMagico lets you create professional slideshows from your photos and music with just a few, simple mouse clicks. It sports a very clean and intuitive yet powerful user interface. High image... Read more
beaTunes 4.6.12 - Organize your music co...
beaTunes is a full-featured music player and organizational tool for music collections. How well organized is your music Library? Are your artists always spelled the same way? Any R.E.M. vs REM?... Read more
Spotify 1.0.49.125. - 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

The best sales on the App Store this wee...
The App Store has quite an exciting lineup of discount games this week that range across a variety of genres. It's a great opportunity to catch up on some of the premium games you may have been holding off on -- and some you can even grab for free... | Read more »
The best new games we played this week
Ah, here we are again at the close of another busy week. Don't rest too easy, though. We had a lot of great new releases in mobile games this week, and now you're going to have to spend all weekend playing them. That shouldn't be too much of a... | Read more »
Rollercoaster Tycoon Touch Guide: How to...
| Read more »
Rabbids Crazy Rush Guide: How to unlock...
The Rabbids are back in a new endless running adventure, Rabbids Crazy Rush. It's more ridiculous cartoon craziness as you help the little furballs gather enough fuel (soda) to get to the moon. Sure, it's a silly idea, but everyone has dreams --... | Read more »
Tavern Guardians (Games)
Tavern Guardians 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Tavern Guardians is a Hack-and-Slash action game played in the style of a match-three. You can experience high pace action... | Read more »
Slay your way to glory in idle RPG Endle...
It’s a golden age for idle games on the mobile market, and those addictive little clickers have a new best friend. South Korean developer Ekkorr released Endless Frontier last year, and players have been idling away the hours in the company of its... | Read more »
Tiny Striker: World Football Guide - How...
| Read more »
Good news everyone! Futurama: Worlds of...
Futurama is finding a new home on mobile in TinyCo and Fox Interactive's new game, Futurama: Worlds of Tomorrow. They're really doing it up, bringing on board Futurama creator Matt Groening along with the original cast and writers. TinyCo wants... | Read more »
MUL.MASH.TAB.BA.GAL.GAL (Games)
MUL.MASH.TAB.BA.GAL.GAL 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: ENDLESS UPGRADES. CONSTANT DANGER. ANCIENT WISDOM. BOUNCY BALLS. Launch Sale, 40% OFF for a very limited time!!! MUL.... | Read more »
Dungeon Rushers (Games)
Dungeon Rushers 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Dungeon Rushers is a 2D tactical RPG combining dungeon crawler’s gameplay and turn based fights. Manage your team, loot dusty... | Read more »

Price Scanner via MacPrices.net

13-inch 2.0GHz Apple MacBook Pros on sale for...
B&H has the non-Touch Bar 13″ 2.0GHz MacBook Pros in stock today and on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.0GHz MacBook Pro Space Gray (... Read more
15-inch Touch Bar MacBook Pros on sale for up...
B&H Photo has the new 2016 15″ Apple Touch Bar MacBook Pros in stock today and on sale for up to $150 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.7GHz Touch Bar... Read more
12-inch Retina MacBooks on sale for $1150, $1...
B&H has 12″ 1.1GHz Retina MacBooks on sale for $150 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 12″ 1.1GHz Space Gray Retina MacBook: $1149 $150 off MSRP - 12″ 1.1GHz... Read more
Apple restocks refurbished 11-inch MacBook Ai...
Apple has Certified Refurbished 11″ MacBook Airs (the latest models recently discontinued by Apple), available for up to $170 off original MSRP. An Apple one-year warranty is included with each... Read more
Apple Park Opens to Employees in April With T...
Apple has announced that Apple Park, the company’s new 175-acre campus, will be ready for employees to begin occupying in April. The process of moving more than 12,000 people will take over six... Read more
Manhattan Neighbors for Safer Telecommunicati...
A new education and advocacy group focused on cell phone and wireless risks, Manhattan Neighbors for Safer Telecommunications, launched today at http://www.ManhattanNeighbors.org. Manhattan... Read more
Portable Dual DisplayPort Monitor Dock Enable...
IOGEAR has announced the launch of its USB-C Dual DisplayPort Monitor Portable Dock (GUC3CMST). The dock enables users to easily connect two DisplayPort monitors to a USB-C or Thunderbolt 3 laptop to... Read more
13-inch 2.7GHz Retina MacBook Pro on sale for...
Amazon.com has restocked the 13″ 2.7GHz/128GB Retina MacBook Pro (MF839LL/A) for $200 off MSRP including free shipping: - 13″ 2.7GHz/128GB Retina MacBook Pro: $1099 $200 off MSRP This model tends to... Read more
Apple’s New iPad Ads Don’t Address Pro Users’...
Apple launched a new tranche of iPad Pro TV ads last week addressing actual queries and challenges from the Twitterverse, albeit using actors for the visuals. That’s great. As an iPad fan and heavy... Read more
Free Verbum Catholic Bible Study App For iOS
The Verbum mobile app runs on Logos’ powerful Bible software and is an advanced resource for mobile Catholic study. The Verbum app surrounds the Bible with the Tradition. Verbum comes with 15 free... Read more

Jobs Board

*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- Chicago...
SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
Manager *Apple* Systems Administration - Pu...
Req ID 3315BR Position Title Manager, Apple Systems Administration Job Description The Manager of Apple Systems Administration oversees the administration and 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
Manager *Apple* Systems Administration - Pu...
Req ID 3315BR Position Title Manager, Apple Systems Administration Job Description The Manager of Apple Systems Administration oversees the administration and Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.