TweetFollow Us on Twitter

XCMD Import Text
Volume Number:4
Issue Number:10
Column Tag:HyperChat®

XCMD Corner

By Donald Koscheka, Apple Computers, Inc.

Importing Text into Hypercard

A new controversy seems to be emerging in the Hypercard community. Some Hypercard pundits are discouraging the use of XCMDs and XFCNs in stack design.. Their most convincing argument is that those of us who jump into writing XCMDs aren’t giving ourselves an opportunity to see if HyperTalk can perform the task, perhaps equally as well as an XCMD.

I frequently consider writing an XCMD solution to a programming problem without first considering whether Hypertalk can do the same job for me. Recently, I needed to import Microsoft WORD files into Hypercard. What a wonderful opportunity to write an XCMD!

When I sat down to write the script to invoke the XCMD, I realized that I could write the entire WORD import routine in HyperTalk. Ed Wischmeyer of Apple Computer Inc. pointed out that although fields in HyperTalk prefer to see straight ASCII text, there is no such restriction on the contents of containers. Hypercard also allows you to open and read any file type you want; you aren’t restricted to reading text files. Of course, you need to figure out how to translate what’s in that container into a format that can be presented in a field.

The hard part of importing text from a Word file is not reading the data into hypercard but rather figuring how Word stores its text. By committing the import code to a simple Hypertalk script, I could concentrate my efforts at decoding Word’s file format.

To simplify my search through the file format, I made the assumption that I could ignore any formatting information such as rulers, font and style changes. I was after was the text portion of the file only. This turns out to be a valid assumption since I wanted to import the file into a Hypercard field as text.

Finding the text was a snap with John Mitchell’s “FEDIT+”. I created a Word file using WORD and then examined it in FEDIT+. I noticed that the text always started at location 256 in the file. Since the size of the file was larger than the size of the text plus this 256 byte header, I needed to determine where the end of text occurred (assuming that the formatting and ruler information follows the text in the file). Since I knew how long the text was, I again used FEDIT+ to search the 256 header portion of the file. This time I was looking for any portion of the header that contained a count of the number of bytes in the text. Since I knew that my file contained exactly 100 characters (bytes), all I had to do was find this number somewhere in the header portion of the file. I found something close to what I was looking for at offset 16 in the file. This location corresponded to the number of characters in the text portion of the file plus 256 which was the length of the header.

The creators of Microsoft Word may be reading this and wondering why I’m assuming that the text size is a 16-bit entity rather than a 32 bit number. I’m not. Since Hypercard text fields are currently limited to 32K bytes, and since I knew none of my word files were longer than this, I’m only interested in the low-order word of the text length.

Reading the text portion of a Microsoft Word file into a hypercard container requires the following steps: (1) Position the mark at byte 16 of the file. Read the byte at this position and multiply it by 256 making it the high-order half of the file length. Read the next byte and add it to the hight-order half of the length. Move 238 more bytes into the file (16+2+238 = 256). This is the start of the text portion of the file. Read the number of bytes calculated minus 256. The IT container gets the imported text.

The Hypertalk script in listing 1 performs the above steps for importing up to 16K bytes of text from a Word file. I use Steisplay WORD files only in the GetFile dialog and to get the full pathname of the file from the user. This script reads in the text without any looping so an XCMD may not speed things up enough to be warranted.

{1}
on mouseup
  put filename(“WDBN”)into filename
  if filename is not empty then
     open file filename -- filename is the full pathname of a WORD file
     read from file filename for 16 -- move file mark to the text length 
word
     read from file filename for 1  -- read the upper half of the length
     put chartonum( it ) * 256 into filesize -- shift up by 8 bits
     read from file filename for 1  -- get the lower half of the length
     add chartonum( it ) mod 256 to filesize
     read from file filename for 238-- move to start of text in the file
     read from file filename for filesize-256 -- read in the text
     close file filename -- IT now contains the imported data.    
  end if
end mouseup

Listing 1. Script to Import Text from a Microsoft Word File

Not all file formats can be imported quite so simply. Macwrite uses a packed text format, storing one or two characters per byte using a simple compression scheme.

Because the text is compressed, we can’t just read the file into a container and return the result to Hypercard. We must first decompress the file a byte at a time. Such a process suggests looping and loops, as we know, are not particularly fast in HyperTalk. Although the decompression can be performed in a hypertalk script, we can write an xcmd that performs the decompression faster.

The key to reading in a MacWrite file is understanding that Macwrite stores its data by paragraph. Whereas Word files are clearly divided between the text and formatting information, Macwrite stores formatting information for each paragraph at the end of the text for that paragraph. Hypercard doesn’t do formatted text; we want to ignore the formatting information at the end of each paragraph. Our algorithm then becomes a loop that reads in a paragraph at a time, decompresses the text for that paragraph ignoring the formatting information. This process is repeated for each paragraph in the file.

One small “gotcha” to this approach stems from the fact that Rulers and pictures are also considered paragraphs. When we encounter either of these objects, we just move on to the next paragraph.

Listing 2 depicts the code for this XFCN. I chose “C” because pointer arithmetic is easier to perform in “C” and because last month’s example was written in Pascal. I made every attempt to keep the “C” isomorphic to a Pascal program so that you can easily convert the code to Pascal.

Finding the paragraph information in the file requires a little arithmetic. Bytes 2-3 in the file tell us how many paragraphs the main document contains (MacWrite makes a distinction between the main document, the header document and the footer document. For our purposes, we only want to read in the main body of text) If bytes 2-3 contain a 5 then there are 5 paragraphs in the main document.

For each paragraph, MacWrite stores an information array. We start reading the information arrays at the file position pointed to in file offset $108. An information array is an array of 16-byte elements that tell us something about each paragraph. The first two bytes in the information array tell us whether the paragraph contains text, a ruler or a picture. If this value is positive the paragraph contains text, if this value is 0 or negative the paragraph is a ruler or a picture respectively and we can ignore it.

Offset 8 in the information array contains a status byte that provides some information about the text. If bit 3 is set, the text in this paragraph is compressed. Bytes 9-11 tell us the absolute file offset for the start of the data in the paragraph and bytes 12-13 contain the length of the data (paragraph addressing is 24 bits and each paragraph contains up to 64K of characters or data). The trick is to read in the number of characters indicated in the information array, determine if the paragraph contains text and, if so, decompress the text if it’s compressed.

Once we read in the paragraph, we get some more information. The first two bytes of the paragraph tell us how many characters of text will appear in the decompressed paragraph. Following the text on an even word boundary is the formatting information for the paragraph which we ignore in this example.

MacWrite’s text compression is based on a letter frequency scheme stored as STR resource #700 in MacWrite’s resource fork. For English, this string contains “ etnroaisdlhcfp”. Macwrite maps these characters onto the array [$0..$F]. The space character ($20) has a value of 0, letter “e” has a value of 1, “t” a value of 2 and so on. Since any number less than $F can fit into a nibble, the word “eels” can be represented as “$11A8” rather than the byte-wide representation of $65656C73. In this example, we realize a 50% space saving (the best case for this algorithm).

This compression scheme only works for lower-case letters since 4 bits is not enough information to code for word frequency and case for the 14 most popular letters. This scheme also doesn’t compress non-alphabetic characters such as numerals and punctuation marks. In these cases, the 16th array element, $F, is used as a flag to tell indicate that the next 2 nibbles represent one character. “Then” would be coded as $F55906. Note that the letter “T” crosses byte boundaries, the top nibble is in byte 0 and the lower nibble is in byte 1. This is of no consequence to the algorithm.

Armed with this information, you should have little trouble understanding the XFCN. In fact, I hope you find it useful and informative! (Next month: printing from XCMDs).

{2}
/*************************\
*file:  MWRead.c *
*  *
* an XFCN that imports text *
* directly from a MacWrite file  *
* whose full pathname is passed  *
* as an input parameter.  *
**
* -------------------------------- *
* To Build this file:*
**
*C -q2 -g MWRead.c *
**
*link -sn Main=MWRead    *
*-sn STDIO=MWRead *
*-sn INTENV=MWRead  *
*-rt XFCN=301   *
*-m MWREAD MWRead.c.o    *
*“{CLibraries}”CInterface.o  *
*-o “your stack name”*
**
* -------------------------------- *
* By: Donald Koscheka*
* Date: 2-July-1988*
* ©1988, Donald Koscheka  *
*All Rights Reserved *
**
* -------------------------------- *
\*************************/

#include<Types.h>
#include<OSUtils.h>
#include<Memory.h>
#include<Files.h>
#include<Resources.h>
#include  “HyperXCmd.h”

#define INFOPOS  0x00000108
#define PPOS0x00000002
#define COMP0x0008


/* -------------------------- */
/* Define the structure of an */
/* information array element*/
/* */
/* pHite is positive if this*/
/* info array points to text, */
/* ignored otherwise.*/
/* */
/* fPos is the absolute file*/
/* position of the start of */
/* the paragraph in the file*/
/* */
/* fLen is the total length of*/
/* the file including formats */
/* -------------------------- */

typedef struct infoArr {
 short  pHite;/* parag hite */
 short  pixels;/* ignore this */ 
 long pHand;/* ignore this*/
 char status;/* chk comprsn */
 char hiMark;/* msw of mark */
 short  loMark;/* lsw of mark */
 short  fLen;  /* parag. len*/
 short  fmat;  /* ignore this */ 
}infoArr;

/* ------------------------ */

short   ReadFile();
Handle  DeCompress();


pascal void MWRead( paramPtr )
 XCmdBlockPtr  paramPtr;
/*************************
* In:ParamPtr:
*pointer to XCMD param
*block. params[0] is the
*name of the macwrite file
*  to open.
*
* Out:ParamPtr->returnValue
*empty if data could not
*be read, text portion 
*of a   Macwrite document.
*************************/
{
short 
 ref,   /* file reference */
 err,   /* io error  */
 vRef,  /* vol reference  */
 pcnt,  /* #  paragraphs  */
 tSiz,  /* text length  */
 loop;  /* loop counter */
long  
 fSiz,  /* data size */
 iSiz,  /* out data size  */
 iMark,/* iarr file pos */
 fPos;  /* para. offset */
Handle
 ImportText,
 decomp,/* decompressed*/
 temp;
infoArr
 info;
char 
 *fName,
 vName[32];

ImportText = nil;

if( paramPtr->params[0] != nil ){
HLock( paramPtr->params[0] );

GetVol( vName, &vRef );
fName = *(paramPtr->params[0]);
err = FSOpen( fName, vRef, &ref );
HUnlock( paramPtr->params[0] );

if( err == noErr ){
 ImportText = NewHandle( 0 );
 
 /* get paragraph count   */
 fSiz = sizeof( short );
 err=ReadFile(ref,fSiz,&pcnt,(long)PPOS);
 
 /* get infoArray position*/
 fSiz = sizeof( long );
 err=ReadFile(ref,fSiz,&iMark,(long)INFOPOS);
 
 /* read in the paragraphs*/
 for( loop = 0; loop < pcnt; loop++){
 fSiz = sizeof( infoArr );
 err=ReadFile(ref,fSiz,&info,iMark);
 
 if( info.pHite > 0 ){
 /* paragraph is text*/
 
 /* calc text position  */
 fPos=(info.hiMark<<0x10)+info.loMark;
 
 /* get the char count  */
 fSiz = sizeof( short );
 err = ReadFile(ref,fSiz,&tSiz,fPos);
 
 /* read in the text */
 temp = NewHandle((long)tSiz);
 HLock( temp );
 fPos += 2; 
 fSiz = (long)tSiz;
 err = ReadFile(ref,fSiz,*temp,fPos);
 
 if( info.status & COMP ){
 /* paragraph is compressed */
 HLock( temp );
 
 decomp = DeCompress( *temp, tSiz );
 
 HUnlock( temp );
 DisposHandle( temp );
 
 temp = decomp;
 tSiz = (short)GetHandleSize( decomp ); 
 }/* if( info.status & COMP ) */
 
 iSiz = GetHandleSize( ImportText );
 fSiz = (long)tSiz;
 SetHandleSize( ImportText, iSiz+fSiz );
 BlockMove(*temp,(*ImportText)+iSiz,fSiz);
 
 HUnlock( temp );
 DisposHandle( temp );
 }/* if( info.pHite > 0 ) */
 
 iMark = iMark + sizeof( infoArr );
 
 }/* FOR paragraph count  */

 iSiz = GetHandleSize( ImportText );
 SetHandleSize( ImportText, iSiz+1 );
 *((*ImportText)+iSiz) = ‘\0’;
 
 FSClose( ref );
 FlushVol( nil, vRef );
}/* if file opened ok     */

paramPtr->returnValue = ImportText;
}

}

short   ReadFile(ioRef,siz,buf,from)
short   ioRef;
long    siz;
char    *buf;
long    from;
/*************************
* read cnt bytes from the file specified by parms and put 
* the data into the buffer pointed to by buf 
*
* ioRef = file reference number
* siz = number of bytes to read
* buf = where to read in to
* from  = where in file to read from
*
* from is the file mark relative to the start of the file from
* which the read is to start.
*************************/
{
 short  err;
 
 err = SetFPos( ioRef, fsFromStart, from );
 if( err == noErr )
 err = FSRead( ioRef, &siz, buf ); 
 return( err);
}

Handle DeCompress( inp, expcnt )
 char *inp;
 short  expcnt;
/***********************
* Decompress the input handle’s data (inH) and put the result
* in the output Handle (outH).  outH is sized properly and 
* we use the following scheme:
*
*0 1 2 3 4 5 6 7 8 9 A B C D E F
*_ e t n r o a i s d l h c f p !
*
* where _ = SPACE
*! = not compressed
* 
* Consult MacWrite resource str #700 for the decompression
* string in your file (different for other languages).
* cycle through until the decompressed string count 
* matches the expected count
***********************/
{
 short  chcnt;
 register char *op;
 register char hiNib;
 register char loNib;
 char   dc[16];
 Handle outH;
 
 outH = NewHandle( (long)expcnt );

 dc[0]  = 0x020;
 dc[1]  = ‘e’;
 dc[2]  = ‘t’;
 dc[3]  = ‘n’;
 dc[4]  = ‘r’;
 dc[5]  = ‘o’;
 dc[6]  = ‘a’;
 dc[7]  = ‘i’;
 dc[8]  = ‘s’;
 dc[9]  = ‘d’;
 dc[10] = ‘l’;
 dc[11] = ‘h’;
 dc[12] = ‘c’;
 dc[13] = ‘f’;
 dc[14] = ‘p’;
 
 HLock( outH );
 op = *outH;
 chcnt = 0;
 
 while( chcnt < expcnt ){
 hiNib = loNib = *inp++;
 hiNib = hiNib >> 0x04;
 hiNib &=  0x000F;
 loNib &=  0x000F;
 
 if( hiNib < 0x0F ){
 *op++ = dc[hiNib];
 chcnt++;
 if( loNib < 0x0F ){
 *op++ = dc[loNib];
 chcnt++;
 }
 else{ /* next BYTE is a char */
 *op++ = *inp++;
 chcnt++;
 }
 }
 else{
 /* next 2 nibbles represent*/
 /* a complete char which */
 /* is on odd-nibble bounds */
 
 *op  = loNib << 0x04;
 hiNib  = *inp++;
 loNib = hiNib & 0x000F;
 hiNib = hiNib >> 0x04;
 hiNib &= 0x0F;
 *op  = *op | hiNib;
 op++;
 chcnt++;
 
 if( loNib < 0x0F )
 *op++ = dc[loNib];
 else
 *op++ = *inp++;
 chcnt++;
 }
 }
 HUnlock( outH );
 return( outH );
}

#include <XCmdGlue.inc.c>

Listing 2. XFCN to import trxt from a MacWrite Document

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Latest Forum Discussions

See All

Whitethorn Games combines two completely...
If you have ever gone fishing then you know that it is a lesson in patience, sitting around waiting for a bite that may never come. Well, that's because you have been doing it wrong, since as Whitehorn Games now demonstrates in new release Skate... | Read more »
Call of Duty Warzone is a Waiting Simula...
It's always fun when a splashy multiplayer game comes to mobile because they are few and far between, so I was excited to see the notification about Call of Duty: Warzone Mobile (finally) launching last week and wanted to try it out. As someone who... | Read more »
Albion Online introduces some massive ne...
Sandbox Interactive has announced an upcoming update to its flagship MMORPG Albion Online, containing massive updates to its existing guild Vs guild systems. Someone clearly rewatched the Helms Deep battle in Lord of the Rings and spent the next... | Read more »
Chucklefish announces launch date of the...
Chucklefish, the indie London-based team we probably all know from developing Terraria or their stint publishing Stardew Valley, has revealed the mobile release date for roguelike deck-builder Wildfrost. Developed by Gaziter and Deadpan Games, the... | Read more »
Netmarble opens pre-registration for act...
It has been close to three years since Netmarble announced they would be adapting the smash series Solo Leveling into a video game, and at last, they have announced the opening of pre-orders for Solo Leveling: Arise. [Read more] | Read more »
PUBG Mobile celebrates sixth anniversary...
For the past six years, PUBG Mobile has been one of the most popular shooters you can play in the palm of your hand, and Krafton is celebrating this milestone and many years of ups by teaming up with hit music man JVKE to create a special song for... | Read more »
ASTRA: Knights of Veda refuse to pump th...
In perhaps the most recent example of being incredibly eager, ASTRA: Knights of Veda has dropped its second collaboration with South Korean boyband Seventeen, named so as it consists of exactly thirteen members and a video collaboration with Lee... | Read more »
Collect all your cats and caterpillars a...
If you are growing tired of trying to build a town with your phone by using it as a tiny, ineffectual shover then fear no longer, as Independent Arts Software has announced the upcoming release of Construction Simulator 4, from the critically... | Read more »
Backbone complete its lineup of 2nd Gene...
With all the ports of big AAA games that have been coming to mobile, it is becoming more convenient than ever to own a good controller, and to help with this Backbone has announced the completion of their 2nd generation product lineup with their... | Read more »
Zenless Zone Zero opens entries for its...
miHoYo, aka HoYoverse, has become such a big name in mobile gaming that it's hard to believe that arguably their flagship title, Genshin Impact, is only three and a half years old. Now, they continue the road to the next title in their world, with... | Read more »

Price Scanner via MacPrices.net

B&H has Apple’s 13-inch M2 MacBook Airs o...
B&H Photo has 13″ MacBook Airs with M2 CPUs and 256GB of storage in stock and on sale for up to $150 off Apple’s new MSRP, starting at only $849. Free 1-2 day delivery is available to most US... Read more
M2 Mac minis on sale for $100-$200 off MSRP,...
B&H Photo has Apple’s M2-powered Mac minis back in stock and on sale today for $100-$200 off MSRP. Free 1-2 day shipping is available for most US addresses: – Mac mini M2/256GB SSD: $499, save $... Read more
Mac Studios with M2 Max and M2 Ultra CPUs on...
B&H Photo has standard-configuration Mac Studios with Apple’s M2 Max & Ultra CPUs in stock today and on Easter sale for $200 off MSRP. Their prices are the lowest available for these models... Read more
Deal Alert! B&H Photo has Apple’s 14-inch...
B&H Photo has new Gray and Black 14″ M3, M3 Pro, and M3 Max MacBook Pros on sale for $200-$300 off MSRP, starting at only $1399. B&H offers free 1-2 day delivery to most US addresses: – 14″ 8... Read more
Department Of Justice Sets Sights On Apple In...
NEWS – The ball has finally dropped on the big Apple. The ball (metaphorically speaking) — an antitrust lawsuit filed in the U.S. on March 21 by the Department of Justice (DOJ) — came down following... Read more
New 13-inch M3 MacBook Air on sale for $999,...
Amazon has Apple’s new 13″ M3 MacBook Air on sale for $100 off MSRP for the first time, now just $999 shipped. Shipping is free: – 13″ MacBook Air (8GB RAM/256GB SSD/Space Gray): $999 $100 off MSRP... Read more
Amazon has Apple’s 9th-generation WiFi iPads...
Amazon has Apple’s 9th generation 10.2″ WiFi iPads on sale for $80-$100 off MSRP, starting only $249. Their prices are the lowest available for new iPads anywhere: – 10″ 64GB WiFi iPad (Space Gray or... Read more
Discounted 14-inch M3 MacBook Pros with 16GB...
Apple retailer Expercom has 14″ MacBook Pros with M3 CPUs and 16GB of standard memory discounted by up to $120 off Apple’s MSRP: – 14″ M3 MacBook Pro (16GB RAM/256GB SSD): $1691.06 $108 off MSRP – 14... Read more
Clearance 15-inch M2 MacBook Airs on sale for...
B&H Photo has Apple’s 15″ MacBook Airs with M2 CPUs (8GB RAM/256GB SSD) in stock today and on clearance sale for $999 in all four colors. Free 1-2 delivery is available to most US addresses.... Read more
Clearance 13-inch M1 MacBook Airs drop to onl...
B&H has Apple’s base 13″ M1 MacBook Air (Space Gray, Silver, & Gold) in stock and on clearance sale today for $300 off MSRP, only $699. Free 1-2 day shipping is available to most addresses in... Read more

Jobs Board

Medical Assistant - Surgical Oncology- *Apple...
Medical Assistant - Surgical Oncology- Apple Hill Location: WellSpan Medical Group, York, PA Schedule: Full Time Sign-On Bonus Eligible Remote/Hybrid Regular Apply Read more
Omnichannel Associate - *Apple* Blossom Mal...
Omnichannel Associate - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Read more
Cashier - *Apple* Blossom Mall - JCPenney (...
Cashier - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Blossom Mall Read more
Operations Associate - *Apple* Blossom Mall...
Operations Associate - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Read more
Business Analyst | *Apple* Pay - Banco Popu...
Business Analyst | Apple PayApply now " Apply now + Apply Now + Start applying with LinkedIn Start + Please wait Date:Mar 19, 2024 Location: San Juan-Cupey, PR Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.