TweetFollow Us on Twitter

Sector Dumps
Volume Number:5
Issue Number:7
Column Tag:HyperChat™

XCMD Corner: Sector Dumps

By Donald Koscheka, Arthur Young & Company, MacTutor Contributing Editor

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

Reinventing the wheel often provides an opportunity to embellish on the original design. Recently, I needed a file dump utility. Several packages are available “over the counter”, but I needed a utility that dumps the entire file without having to manually move from sector to sector as is the case with most commercial solutions. Moreover, I use file dump tools frequently enough that I could afford to spend the effort writing one for Hypercard.

I dump the file in a fairly typical way. Each line in the dump contains the “sector address” of the first byte on the line followed by the hexadecimal dump of 16 bytes followed by the ASCII interpretation of the data. Not all ASCII characters are “printable” so we replace non-printing characters with the “.”, yielding a cleaner display.

This month’s XFCN, FilePeek.c (listing 1) accepts two parameters. The first parameter is the reference number of the opened file; the second parameter is the sector you want dumped. HFS sectors are 512 bytes so filepeek returns 32 lines of 16 bytes apiece.

Dumping the entire contents of a file becomes a matter of calling FilePeek repeatedly for all the logical sectors in the file.

The first line in the dump tells us how many bytes were read in. This number can be equal to or less than a full sector. If line 1 contains less than a sector full of data, then you know that logical end of file is after the last byte read in.

The Hypertalk afficianado will realize that this code can easily be written in Hypertalk. I chose to commit my scheme to an XFCN only after discovering that the Hypertalk version was too slow for my purposes.

The dumping scheme is amazingly simple. Position the file mark at the beginning of the sector that you want to dump. If the start of the sector extends beyond end of file, do nothing and return to hypercard with a result of zero (no bytes were read in), otherwise read the sector into the buffer we allocated (buf).

The sector is presented to Hypercard as a series of haxadecimal characters. Hypercard contains a call back “NumtoHex” which converts an arbitrary run of data to a hex string. We lose portability when using a callback so you’ll need to write your own hexdump algorithm or dig one up in the toolbox.

FilePeek dumps two bytes at a time (4 hex digits). This is analogous to dumping the contents of a short. We can use a pointer to short (rPtr). To dump the ascii data, we use a char pointer (cPtr) to the same data.

The current line in the dump is assembled by first displaying the “sector address” of that line. The sector address is 512 * blk (blk = sector number).

The sector address is delineated by the “:” character. Following the sector address, we display 16 bytes of data in hexadecimal format. The data is grouped into 8 words.

The hexadecimal data is followed by the ascii representation of the line. If the character falls in the range of printing characters, we display the character, otherwise print a “.”. Characters below the space (0x020) are not normally considered printing characters. Likewise, Inside Macintosh indicates that no characters above $D8 have a printable format. Using the period to represent non-printing characters results in a less-cluttered looking dump.

We need to cycle the character pointer, cPtr, twice for every cycle on rPtr (a character is half a word). We accumulate the ascii data into a separate string which we then concatenate onto the end of the hex data.

Once the current line is assembled, we stick a carriage return on the end, block move it to the output data handle and then go to the next 16 bytes in the input stream. When the outer loop completes, outdata will contain 32 lines of 16 bytes apiece, suitable for framing.

Figure 1.

How you open and close a file from Hypercard is a matter of taste. I prefer to keep my interface to the file manager as clean as possible. This requires passing a filename and working directory id to the file manager’s FSOpen call and subsequently referring to the file by the reference number returned by FSOpen. To close the file, pass the reference number to FSClose (last month I provided an XFCN that will return a file name and working directory id from the standard file package).

Listings 2 and 3 are two simple XFCNs that open and close a file respectively. FileOpen returns a reference number if the file opened ok (0 otherwise). Pass this reference number to FilePeek along with the number of the sector you wish to dump.

Figure 1. is a sample card that I use to dump the contents of the file. The dump is presented in a mono-spaced font to keep it “clean-looking”. The forward and back arrows allow the user to “browse” sectors by moving 1 sector forward or backward. The scripts for theses two buttons is fairly obvious so I’ve left them to the reader. The scripts for open, close are contained in listing 4.

--1

-- file open button
on mouseUp
  global fileName, DirectoryID
  global fileRefNum, theSector
  
  put getFileNameToOpen() into it
  put item 1 of it into fileName
  put item 2 of it into DirectoryID
  put filename into card field “file name”
  
  if filename is not empty then
    Put FileOpen( fileName, DirectoryID ) into fileRefNum
  end if
  
end mouseUp

-- Go to Sector
on mouseUp
  global fileRefNum, theSector
  
  if filerefnum is empty then
    answer “You have to open a file first, silly!”
  else
    
    ask “Read what sector?” with “0”
    
    if (it is not empty) then
      put it into theSector
      Peekat theSector
    end if
  end if
  
end mouseUp

-- file close
on mouseUp
  global fileRefNum
  
  put FileClose( fileRefNum ) into it
  -- ignore the result of a closed file
end mouseUp

Listing 4. Scripts for the buttons

An interesting variation on this theme would be to dump the files in reverse order so that it prints in ascending order on the LaserWriter. Several easy solutions exist for this problem, and I’ll leave it as this month’s exercise to the reader. As a hint, I can think of two ways to do this off hand, one easy but inefficient, the second a little more challenging: (1) create a card for every sector (make sure your file is small first!) or (2) Find out how many sectors the file contains before starting the dump ( a wonderful opportunity to try your hand at XFCN writing).

Note on a bug in last month’s article:

Last month’s XFCN, GetFileName, incorrectly returns the working directory id of the file selected from SFGetFile. Change the call to GetFileNameToOpen to Read:

/* 1 */

if( GetFileNameToOpen(typs,numTypes,FileName,&FileWDID ) ){
 temp = (long)FileWDID & 0xFFFF;
 NumToStr( paramPtr, temp, &WDIDString );
 PtoCstr( WDIDString );
Listing 1:  FilePeek.c

/********************************/
/* File: FilePeek.c*/
/* */
/* Given the sector index into*/
/* an existing file, read the */
/* sector in and “dump” it to */
/* the screen    */
/* */
/* Paramters:    */
/* param0 = file referencenum */
/* ( file is open) */
/* param1 = sector number */
/* (1 sector = 512 bytes) */
/* ----------------------------  */
/* To Build:*/
/* */
/* (1) Create a project using */
/* this file as well as the */
/* XCMD.Glue.c file. (Set */
/* project type to XCMD (or */
/* XFCN) from the Project menu.  */
/* */
/* (2) Bring the project up to*/
/* date.*/
/* */
/* (3) Build Code Resource. */
/* */
/* (4) Use ResEdit to copy the   */
/* resource to your stack.*/
/********************************/

#include<MacTypes.h>
#include<OSUtil.h>
#include<MemoryMgr.h>
#include<FileMgr.h>
#include<ResourceMgr.h>
#include<pascal.h>
#include<strings.h>
#include  “HyperXCmd.h”
#include“HyperUtils.h”

#define SECTOR   512 /***size of input buffer ***/
#define NUMROWS  8 /***across each line***/
#define NUMLINES 32/***lines of data ***/
#define NUMBYTES 16/***#bytes per row of data***/
#define SPACE    0x020  /***the space character***/

long  paramtoNum();
void  appendChar();
void  CopyStrToHandle();
char  *CopyAscii();

pascal void main( paramPtr )
 XCmdBlockPtr  paramPtr;
{
 short  err;
 short  fref;
 short  lc; /* line count */
 short  rc; /* row count  */
 long   cnt;
 long   blk;/* sector number  */
 Handle outData;
 short  *rPtr;   /* per row */
 char   *cPtr;   /* for ASCII */
 char   *aPtr;   /* points to asciival */
 char   *buf;
 char   asciiStr[32];
 char   curntLine[256]; 
 Str31  numString;
 
 outData = 0L;
 if( paramPtr->paramCount == 2 ){  
 /*** expect two parameters ***/
 /*** (1) Get our input parameters ***/
 fref = (short)paramtoNum( paramPtr, 0 );
 blk   = paramtoNum( paramPtr, 1 );

 /*** (2) Read a buffer of data    ***/
 blk = blk * SECTOR;
 err = SetFPos( fref, fsFromStart, blk );
 if ( !err ){
 cnt = SECTOR;
 
 /*** We need to keep this data locked ***/
 /*** Since we can;t trust callbacks not     ***/
 /*** to move stuff, we allocate the ***/
 /*** buffer as non-relocatable.   ***/
 buf = NewPtr( cnt );
 err = FSRead( fref, &cnt, buf );
 
 if ( err != noErr &&  err != eofErr ){
 paramPtr->returnValue = 0L;
 return;
 }
 }
 
 /*** result is returned to hypercard as     ***/
 /*** a null terminated string***/
 outData = NewHandle( 0L );

 /*** (3) Start filling the output buffer    ***/
 *curntLine = ‘\0’;
 
 /*** first the number of bytes read in***/
 NumToHex( paramPtr, cnt, 4 , &numString );

 appendChar( PtoCstr( (char *)&numString), ‘\r’ );
 CopyStrToHandle( &numString, outData );

 /*** point to the input data ***/
 rPtr = (short *)buf;
 
 for( lc = 0;  lc < NUMLINES; ++lc ){
 *curntLine = ‘\0’;

 /*** blk is the sector address  ***/
 NumToHex( paramPtr, blk, 6, &numString );
 PtoCstr( (char *)&numString );
 strcat( curntLine, &numString );
 appendChar( curntLine, ‘:’ );
 appendChar( curntLine, SPACE );
 aPtr = asciiStr;
 blk += NUMBYTES;
 
 for( rc = 0; rc < NUMROWS; ++rc ){
 
 /*** convert eight shorts per row ***/
 /*** if we overrun the buffer, draw ***/
 /*** whatever data follows it...  ***/
 NumToHex( paramPtr, (long)*rPtr, 4 , &numString);
 strcat( curntLine, PtoCstr( (char *)&numString));
 appendChar( curntLine, ‘ ‘ );
 
 cPtr = (char *)rPtr;
 aPtr = CopyAscii( aPtr, *cPtr++ );
 aPtr = CopyAscii( aPtr, *cPtr++ );
 rPtr++;
 }
 
 *aPtr = ‘\0’; /*** terminate the ascii data ***/
 strcat( curntLine, asciiStr );
 appendChar( curntLine, ‘\r’ );
 
 /*** move  line into output buffer***/
 CopyStrToHandle( curntLine, outData );
 }
 
 DisposPtr( buf );
 }
 
 cnt = GetHandleSize( outData );
 *(*outData + cnt) = ‘\0’;
 paramPtr->returnValue = outData;
}

long  paramtoNum( paramPtr, i )
 XCmdBlockPtr  paramPtr;
 short  i;
/************************
* Given a handle to an input
* argument in the paramBlk
* return an integer representation
* of the data.
*
************************/
{
 Str31  theStr;
 
 HLock( paramPtr->params[ i ] );
 ZeroToPas( paramPtr, *(paramPtr->params[ i ]), &theStr );
 HUnlock( paramPtr->params[ i ] );
 return( StrToLong( paramPtr, &theStr ) );
}

void  appendChar( theStr, theChar )
 char *theStr;
 char theChar;
/************************
* append the character passed
* to the end of the string 
************************/
{
 long len = strlen( theStr );
 char *theEnd;

 theEnd = theStr + len;
 *theEnd++  = theChar;
 *theEnd  = ‘\0’;
}

char  *CopyAscii( outStr, theChar )
 char *outStr;
 char theChar;
/************************
* if the character passed  
* in the input stream is a 
* printing character, append
* it to the output string,
* otherwise, append the ‘.’
*
* return the update output 
* string.
************************/
{
 if ( theChar >= SPACE  &&  theChar <= 0x0D8  ) 
 *outStr++ = theChar;
 else
 *outStr++ = ‘.’;
 
 return( outStr );
}

void CopyStrToHandle( theStr, hand )
 char *theStr;
 Handle hand;
/************************
* Copy the input data to the
* output handle.
*
************************/
{
 long cnt = strlen( theStr );
 long oldSize  = GetHandleSize( hand );

 SetHandleSize( hand, oldSize + cnt );
 BlockMove( theStr, *hand + oldSize, cnt );
}
Listing 2: FileOpen.c

/********************************/
/* File: FIleOpen.c*/
/* */
/* open the file whose name and */
/* working directory id are */
/* passed as parameters.  This*/
/* information can be obtained*/
/* using GetFileNameToLoad... */
/* */
/* Paramters:    */
/* param0 = file namenum  */
/* param1 = directory id  */
/* */
/* Out: */
/* File RefNum if opened, 0 */
/* otherwise*/
/* ----------------------------  */
/********************************/

#include<MacTypes.h>
#include<OSUtil.h>
#include<MemoryMgr.h>
#include<FileMgr.h>
#include<ResourceMgr.h>
#include<pascal.h>
#include<strings.h>
#include  “HyperXCmd.h”
#include“HyperUtils.h”

pascal void main( paramPtr )
 XCmdBlockPtr  paramPtr;
{
 char   *filename;
 Str31  str, fName;
 short  wdid, refnum;

 HLock( paramPtr->params[0] );
 ZeroToPas( paramPtr, *(paramPtr->params[0]), &fName );
 HUnlock( paramPtr->params[0] );
 
 /* convert the wdid to a usable form */
 HLock( paramPtr->params[1] );
 ZeroToPas( paramPtr, *(paramPtr->params[1]), &str );
 HUnlock( paramPtr->params[1] );
 wdid = (short)StrToNum( paramPtr, &str );
 
 if( FSOpen( &fName, wdid, &refnum) == noErr )
 NumToStr( paramPtr, (long)refnum, &str );
 else
 NumToStr( paramPtr, 0L, &str );

 paramPtr->returnValue = PasToZero( paramPtr, &str );
}
Listing 3:  FileClose.c

/********************************/
/* File: FileClose.c */
/* */
/* XCMD to access the file mgr*/
/* call FSClose  */
/* Paramters:    */
/* param0 = file reference from  */
/* the fileopen xcmd */
/* ----------------------------  */
/********************************/

#include<MacTypes.h>
#include<OSUtil.h>
#include<MemoryMgr.h>
#include<FileMgr.h>
#include<ResourceMgr.h>
#include<pascal.h>
#include<strings.h>
#include  “HyperXCmd.h”
#include“HyperUtils.h”

pascal void main( paramPtr )
 XCmdBlockPtr  paramPtr;
{
 short  refnum;
 char   str[256];
 
 /* convert the refnum to a usable form */
 HLock( paramPtr->params[0] );
 ZeroToPas( paramPtr, *(paramPtr->params[0]), &str );
 HUnlock( paramPtr->params[0] );
 refnum = (short)StrToNum( paramPtr, &str );
 
 /* Normally we should check the result      */
 /* code but it won’t kill us to ignore*/
 /* the reslt of a close file call */
 if ( FSClose(refnum) )
 ;
 paramPtr->returnValue = 0L;
}

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

OmniGraffle Pro 7.19.3 - 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 7.19.3 - Create diagrams, fl...
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
Hopper Disassembler 5.3.3- - Binary disa...
Hopper Disassembler is a binary disassembler, decompiler, and debugger for 32- and 64-bit executables. It will let you disassemble any binary you want, and provide you all the information about its... Read more
calibre 5.35.0 - Complete e-book library...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital librarian... Read more
Sound Studio 4.10.0 - Robust audio recor...
Sound Studio lets you easily record and professionally edit audio on your Mac. Easily rip vinyls and digitize cassette tapes, or record lectures and voice memos. Prepare for live shows with live... Read more
Sparkle Pro 4.0 - Visual website creator...
Sparkle Pro will change your mind if you thought building websites wasn't for you. Sparkle is the intuitive site builder that lets you create sites for your online portfolio, team or band pages, or... Read more
Dropbox 140.4.1951 - Cloud backup and sy...
Dropbox for Mac is a file hosting service that provides cloud storage, file synchronization, personal cloud, and client software. It is a modern workspace that allows you to get to all of your files... Read more
FotoMagico 6.0.5 - Powerful slideshow cr...
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
Remotix 6.4.2 - Access all your computer...
Remotix is a fast and powerful application to easily access multiple Macs (and PCs) from your own Mac. Features: Complete Apple Screen Sharing support - including Mac OS X login, clipboard... Read more
Microsoft Office 365, 2019 16.57 - Popul...
Microsoft Office 365. The essentials to get it all done. Unmistakably Office, designed for Mac Get started quickly with new, modern versions of Word, Excel, PowerPoint, Outlook and OneNote-... Read more

Latest Forum Discussions

See All

A House Full of Covid – The TouchArcade...
It’s been a rough week as both of our young children tested positive for Covid, and since recording this early on Friday my wife has tested positive now too. Thankfully the kids seemed to recover fairly quickly and are mostly back to normal, and I... | Read more »
TouchArcade Game of the Week: ‘Krispee S...
Krispee Street is a new hidden object game from Frosty Pop that is based on their popular and almost painfully sweet webcomic Krispee. This is one of the latest titles to be added to the Netflix Games catalog, which means you’ll need to log into... | Read more »
SwitchArcade Round-Up: ‘Escape Lala’, ‘B...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for January 21st, 2022. In today’s article, we’ve got a lot of new releases. A lot. There were eight on the schedule when I went to bed last night. There were twenty-four when I woke up... | Read more »
Beta Testers Needed for Huge Version 2.0...
Ya’ll remember Dungeon Raid, right? The phenomenal matching RPG hybrid that launched on mobile more than a decade ago, but was more or less abandoned by its developer only to die a slow death on the App Store before the 32-bit Appocalypse finally... | Read more »
‘Ark Legends’ Gives Players a Chance to...
It’s Airpods and Amazon gift cards galore as Melting Games opens pre-registration for Ark Legends. The upcoming mobile RPG is giving away tons of in-game goodies such as gold, energy, iron core, hero summon chest and rare iron core to players who... | Read more »
‘Nickelodeon Extreme Tennis’ Out Now on...
Nickelodeon Extreme Tennis () from Old Skull Games and Nickelodeon is this week’s new Apple Arcade release. Nickelodeon Extreme Tennis features characters from old and new Nickelodeon shows including SpongeBob, TMNT, and many more. The tennis game... | Read more »
SwitchArcade Round-Up: ‘RPGolf Legends’,...
Hello gentle readers, and welcome to the SwitchArcade Round-Up for January 20th, 2022. In today’s article, we’ve got a massive amount of new releases to check out. We’ve got summaries of all of them, from heaven to hell. We also have the lists of... | Read more »
‘Zed Blade ACA NEOGEO’ Review – Well, It...
SNK’s NEOGEO platform played host to a great many classics, both famous and under-the-radar. The Metal Slug games. The King of Fighters series. Magician Lord. Shock Troopers. Sengoku 3. NEO Turf Masters. Fatal Fury. Samurai Shodown. Twinkle Star... | Read more »
‘Inua – A Story in Ice and Time’ is a Un...
One thing I know about ARTE from their output on mobile over the years is that they love collaborating with really interesting and unique studios to put out really interesting and unique gaming experiences. This is true yet again with the latest... | Read more »
Out Now: ‘Angry Birds Journey’, ‘RPG Dic...
Each and every day new mobile games are hitting the App Store, and so each week we put together a big old list of all the best new releases of the past seven days. Back in the day the App Store would showcase the same games for a week, and then... | Read more »

Price Scanner via MacPrices.net

Amazon lowers prices on select 13″ M1 MacBook...
Amazon has select Apple 13″ M1 MacBook Airs on sale for $150 off MSRP this weekend, starting at only $849. Their prices are the lowest available for new MacBook Airs today. Stock may come and go, so... Read more
Apple has 13″ M1 MacBook Airs back in stock s...
Apple has restocked a full line of 13″ M1 MacBook Airs, Certified Refurbished, starting at only $849 and up to $190 off original MSRP. These are the cheapest M1-powered MacBooks for sale today at... Read more
In stock and on sale! 16″ 10-Core M1 Pro MacB...
Amazon has new 16″ 10-Core/512GB M1 Pro MacBook Pros in stock today and on sale for $50 off MSRP including free shipping. Their prices are the lowest available for new M1 Pro 16″ MacBook Pro from any... Read more
Deal Alert!: 14″ M1 Pro with 10-Core CPU in s...
Amazon has the new 14″ M1 Pro MacBook Pro with a 10-Core CPU and 16-Core GPU in stock today and on sale for $2299.99 including free shipping. Their price is $200 off Apple’s standard MSRP, and it’s... Read more
Apple has 24-inch M1 iMacs (8-Core CPU/8-Core...
Apple has restocked a wide array of 24-inch M1 iMacs with 8-Core CPUs and 8-Core GPUs in their Certified Refurbished store. Models are available starting at only $1269 and range up to $260 off... Read more
Select 24″ M1 iMacs are on sale for $100 off...
Sales of Apple’s new 24″ M1 iMacs have been rare since its introduction, perhaps due to global supply issues. However, B&H is offering a $100 discount on select 24″ iMacs, and they’re in stock... Read more
M1 Mac minis are back in stock today at Apple...
Apple has M1-powered Mac minis available in their Certified Refurbished section starting at only $589 and up to $140 off MSRP. Each mini comes with Apple’s one-year warranty, and shipping is free: –... Read more
B&H has M1-powered Mac minis on sale for...
B&H Photo has Apple’s Mac minis with M1 Apple Silicon CPUs in stock today and on sale for $50-$100 off MSRP, starting at $649. Free 1-2 shipping is free to many US addresses. Their prices are... Read more
New Amazon sale: Apple’s 13″ M1 MacBook Airs...
Amazon has Apple 13″ M1 MacBook Airs on sale for $100 off MSRP, starting at only $899. Their prices are the lowest available for new MacBook Airs today. Stock may come and go, so check their site... Read more
Get an Apple Watch Series 7 for $50 off MSRP,...
Amazon has Apple Watch Series 7 models on sale for $50 off MSRP including free shipping. Their prices are the lowest available for Apple Watch Series 7 models today: – 41mm Apple Watch Series 7 GPS... Read more

Jobs Board

Registered Nurse (RN) Employee Health PSJH -...
…is calling for a Registered Nurse (RN) Employee Health PSJH to our location in Apple Valley, CA.** We are seeking a Registered Nurse (RN) Employee Health PSJH to be Read more
Systems Administrator - Pearson (United State...
…and troubleshoot Windows operating systems (workstation and server), laptop computers, Apple iPads, Chromebooks and printers** + **Administer and troubleshoot all Read more
IT Assistant Level 1- IT Desktop Support Anal...
…providing tier-1 or better IT help desk support in a large Windows and Apple environment * Experience using IT Service Desk Management Software * Knowledge of IT Read more
Human Resources Business Partner PSJH - Provi...
…**is calling a** **Human Resources Business Partner, PSJH** **to our location in Apple Valley, CA.** **Applicants that meet qualifications will receive a text with Read more
Manager Community Health Investment Programs...
…is calling a Manager Community Health Investment Programs PSJH to our location in Apple Valley, CA.** **Qualified candidates will be invited to do a self-paced video Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.