TweetFollow Us on Twitter

Catalog XCMD
Volume Number:5
Issue Number:11
Column Tag:HyperChat™

Related Info: File Manager (PBxxx)

XCMD Corner: Catalog XCMD

By Donald Koscheka, Arthur Young & Co., MacTutor Contributing Editor

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

Bullet Proofing

Recently, Joe Palooka wrote to complain about a bug in the GetFileName XCMD that appeared in this column a few months back. Apparently, the xcmd bombed if you passed it more than four file types. But this letter raises a more important issue: how much bulletproofing should I do to my code examples?

Before you jump to the obvious conclusion, allow me to make my case. Bulletproofing my code examples carries three liabilities for this column, size and clarity and time. The former is obvious. This magazine can carry only a certain number of pages per issue. Exceeding that page limit on a regular basis will result in my column getting bumped or serialized. I would like to avoid either case.

Clarity is not so obvious and, in fact, is a function of size. The larger a program is, the more unreadable it becomes. Bulletproofing code tends to be fairly routine, and one can almost apply a formula to XCMDs for bulletproofing: (1) Are the input parameters defined? (2) if so, are they properly conditioned (e.g. correct number of data).

The final liability is time. My years of experience have taught me that a large amount of a programming project’s time is spent anticipating exceptions. Working under a monthly deadline, it is often necessary to eliminate this step. I don’t see any contradiction here. If you intend to use my code in your own product, then it’s incumbent on you test its effectiveness. Bulletproofing my examples will only make your job harder and even then, I have no way of anticipating your exceptions (i.e. what happens to subroutine x if I make this small change to its parameters?)

This code tends to take the form:

if( paramPtr->params[i] && **(paramPtr->params[i]) )...

Testing the input parameters is something else entirely and can easily exceed the size of the “functional code”.

This is not to belittle the need for bulletproof code. Far from it. If you intend to use the code in this column, you should use it as a starting point. In general, if you intend to use somebody else’s code, you should seek answers to these questions: what does the code do? what doesn’t the code do?

At any rate, I will leave this issue on your hands. Write to the editor and let him know your feelings.

Catalog

One good XCMD deserves another. Recently, Joe Zuffoletto called me to ask whether I had any intentions of writing an XCMD that returns a catalog of a given directory. You may recall that Joe gave us the series on adding standard Mac windows to Hypercard. Such code cannot go unrewarded and so this month’s xcmd ...

Catalog accepts parameters in one of two forms. If you pass a pathname in the first parameter, it will return a catalog of all files in that directory. If the first parameter is empty, then Catalog will use the second parameter as directory reference number. This second parameter requires further explaining by way of the file manager.

When the user selects a file from the standard file dialog, the name as well as the volume reference number is passed back to the caller. Under HFS, the volume reference number masquerades as a working directory id. In reality, this reference number acts as either a volume reference number or a working directory id. How the file manager tells them apart is subtle but important:

Volume reference numbers are small negative integers such as -1, -2, -3... In fact, if you pass such a number to Catalog, you will get a listing of the root directory of the volume in question.

Working directory id’s are x. Working directories must not be confused with directory id’s. Each file has a unique id assigned to it called a directory id. This id is a long integer that uniquely identifies a file or folder. Working directory id’s by contrast are integers and are not unique for a given folder. Working directories are very much like file reference numbers. When a working directory is opened by the call, PBOpenWD, a reference number is returned in the vRefNum field.

Listing 1:

/********************************/
/* File: Catalog.c */
/* */
/* Given the reference number of*/
/* a working directory or volume*/
/* return a list of all files & */
/* folders in that directory*/
/* */
/* if a name is given, use it,*/
/* otherwise, use the id passed  */
/********************************/

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

#define nil 0L

extern  GetCatalog();

pascal void main( paramPtr )
 XCmdBlockPtr  paramPtr;
{
 Handle catalog;
 Str31  str;
 short  dirID;

 /*** intialize the output container ***/
 catalog = NewHandle( 0L );
 
 /*** convert the wdid to a usable form            ***/
 if( paramPtr->params[1] ){
 HLock( paramPtr->params[1] );
 ZeroToPas( paramPtr, *(paramPtr->params[1]), &str );
 HUnlock( paramPtr->params[1] );
 dirID = (short)StrToNum( paramPtr, &str );

 /*** given the id of a directory, ***/
 /*** return a catalog for that directory ***/
 GetCatalog( dirID, catalog );
 }
 else if( paramPtr->params[0] ){ 
 char   path[256];
 CInfoPBRec catPB;
 WDPBRecwdPB;
 
 HLock( paramPtr->params[0] );
 ZeroToPas( paramPtr, *(paramPtr->params[0]), &path );
 HUnlock( paramPtr->params[0] );
 
 /*** get a directory id to this path***/          
 catPB.dirInfo.ioNamePtr  = (StringPtr)path;
 catPB.dirInfo.ioFDirIndex  = 0;
 catPB.dirInfo.ioVRefNum  = 0;
 if( PBGetCatInfo( &catPB, 0 ) == noErr )
   if( catPB.dirInfo.ioFlAttrib & 0x010 ){   /*** it’s a directory
 ***/
 wdPB.ioNamePtr  = (StringPtr)path; 
   wdPB.ioWDProcID = 0;
  
 if( PBOpenWD( &wdPB, 0 ) == noErr ){
 wdPB.ioWDVRefNum= catPB.dirInfo.ioVRefNum;
 wdPB.ioWDDirID  = catPB.dirInfo.ioDrDirID;
 GetCatalog( wdPB.ioVRefNum, catalog );
 PBCloseWD( &wdPB, 0 );
 }
   }
 }
 /*** append a null to the end of the***/
 /*** the directory for Hypercard  ***/
 AppendCharToHandle( catalog, ‘\0’ );
 
 paramPtr->returnValue = catalog;
}
Listing 2:

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

/*** If you read this column***/
/*** column on a regular basis***/
/*** you may want to add these***/
/*** routines to HyperUtils.c ***/
/*** If you don’t have Hyper- ***/
/*** utils.c, you can obtain it  ***/
/*** from MacTutor for a small***/
/*** handling charge ***/

#define SYNC0

AppendCharToHandle( theHand, theChar )
 Handle theHand;
 char theChar;
/****************************
* Given a valid handle, append
* the character passed in to 
* the end of the handle
* 
* This is a useful way to embed
* \r, \t or \0 into a container
* for use by hypercard.
****************************/
{
 long   hsiz = GetHandleSize( theHand );
 char   *dirP;

 SetHandleSize( theHand, hsiz + 1 );
 dirP = *theHand + hsiz;
 *dirP= theChar;
}

GetCatalog( wdref, dirH )
 short  wdref;
 Handle dirH;
/****************************
* Get a listing of the directory
* passed in.
* In:
*  wdref == reference number of the
*  the desired working directory
*dirH == handle to the output container.
* Note that we allocate all structures 
* in the heap to minimize the impact
* a high directory valence might have
* on the stack.
****************************/
{
 OSErr  done= 0; /* goes true when done searching  */
 CInfoPBPtr catPB= (CInfoPBPtr)NewPtr( sizeof(CInfoPBRec));
 WDPBPtrwdPB= (WDPBPtr)NewPtr( sizeof(WDPBRec));
 char   *fname = (char *)NewPtr( 256L );

 if( catPB && wdPB && fname ){
 catPB->dirInfo.ioNamePtr = (StringPtr)fname;
 catPB->dirInfo.ioFDirIndex = 0;
 catPB->dirInfo.ioVRefNum = wdref; 
 
 do{
 *(catPB->dirInfo.ioNamePtr) = ‘\0’;
 catPB->dirInfo.ioFDirIndex++;
 catPB->dirInfo.ioDrDirID = 0; 
 
 if( (done = PBGetCatInfo( catPB, SYNC ) ) == noErr ){
 pStrToField( fname, ‘’, dirH );
   if( catPB->dirInfo.ioFlAttrib & 0x010 ){  /*** it’s a directory
 ***/
 AppendCharToHandle( dirH, ‘:’ );
   }
   AppendCharToHandle( dirH, ‘\r’ );
 }
 }while( !done );
 
 DisposPtr( (Ptr)catPB );
 DisposPtr( (Ptr)wdPB );
 DisposPtr( (Ptr)fname );
 }
}

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Carbon Copy Cloner 4.1.18 - Easy-to-use...
Carbon Copy Cloner backups are better than ordinary backups. Suppose the unthinkable happens while you're under deadline to finish a project: your Mac is unresponsive and all you hear is an ominous,... Read more
Hopper Disassembler 4.2.14- - Binary dis...
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
BetterTouchTool 2.291 - Customize Multi-...
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
Sound Studio 4.8.11 - 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
Sound Studio 4.8.11 - 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
BetterTouchTool 2.291 - Customize Multi-...
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
Carbon Copy Cloner 4.1.18 - Easy-to-use...
Carbon Copy Cloner backups are better than ordinary backups. Suppose the unthinkable happens while you're under deadline to finish a project: your Mac is unresponsive and all you hear is an ominous,... Read more
Hopper Disassembler 4.2.14- - Binary dis...
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
VOX 2.8.30 - Music player that supports...
VOX just sounds better! The beauty is in its simplicity, yet behind the minimal exterior lies a powerful music player with a ton of features and support for all audio formats you should ever need.... Read more
Default Folder X 5.1.6b3 - Enhances Open...
Default Folder X attaches a toolbar to the right side of the Open and Save dialogs in any OS X-native application. The toolbar gives you fast access to various folders and commands. You just click on... Read more

The best 2v2 card combos in Clash Royale
2v2 is making it's grand return toClash Royalequite soon. 2v2 has quickly become one of the game's most popular gameplay modes, though they still have yet to make it a permanent fixture in the game. 2v2 is exciting and adds some new flavor to... | Read more »
The best games we played this week - Aug...
Another busy week has come to a close. We played a lot of excellent games this week and now it's time to look back and reflect on some our favorites. Here are our picks for the week of August 18. [Read more] | Read more »
War Wings beginner's guide - how to...
War Wings is the newest project from well-established game maker Miniclip. It's a World War II aerial dogfighting game with loads of different airplane models to unlock and battle. The game offers plenty of single player and multiplayer action. We... | Read more »
How to win every 2v2 battle in Clash Roy...
2v2 is coming back to Clash Royale in a big way. Although it's only been available for temporary periods of time, 2v2 has seen a hugely positive fan response, with players clamoring for more team-based gameplay. Soon we'll get yet another taste of... | Read more »
Roll to Win with Game of Dice’s new upda...
Joycity’s hit Game of Dice gets a big new update this week, introducing new maps, mechanics, and even costumes. The update sets players loose on an exciting new map, The Cursed Tower, that allows folks to use special Runes mid-match. If you feel... | Read more »
Bottom of the 9th (Games)
Bottom of the 9th 1.0.1 Device: iOS iPhone Category: Games Price: $4.99, Version: 1.0.1 (iTunes) Description: Play the most exciting moment of baseball in this fast-paced dice and card game! | Read more »
The best apps for viewing the solar ecli...
If you somehow missed the news, many parts of the United States will be witness to a total solar eclipse on August 21 for the first time in over 90 years. It'll be possible to see the eclipse in at least some capacity throughout the continental U... | Read more »
The 5 best mobile survival games
Games like ARK: Survival Evolved and Conan Exiles have taken the world of gaming by storm. The market is now flooded with hardcore survival games that send players off into the game's world with nothing but maybe the clothes on their back. Never... | Read more »
Portal Walk (Games)
Portal Walk 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Portal Walk is adventure and relaxing platform game about Eugene. Eugene stuck between worlds and trying to find way back home.... | Read more »
Technobabylon (Games)
Technobabylon 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: City of Newton, 2087. Genetic engineering is the norm, the addictive Trance has replaced almost any need for human interaction,... | Read more »

Price Scanner via MacPrices.net

Weekend sale: 13-inch MacBook Pros for up to...
Amazon has new 2017 13″ MacBook Pros on sale today for up to $200 off MSRP, each including free shipping: – 13″ 3.1GHz/256GB Space Gray MacBook Pro (MPXV2LL/A): $1599.99 $200 off MSRP – 13″ 3.1GHz/... Read more
Back To School With The Edge Desk All-in-one...
Back to school is just around the corner, and the ergonomically correct Edge Desk all-in-one portable kneeling desk is ideal for students living in dorms and small apartments, Edge Desk features:... Read more
Norton Core Secure Wi-Fi Router Now Available...
First introduced at the 2017 Consumer Electronics Show (CES), Norton Core, a secure, high-performance Wi-Fi router, fundamentally changed the concept of Wi-Fi routers by making security the primary... Read more
ViewSonic Adds New 27-inch 4K UHD Monitor to...
ViewSonic Corp. has introduced the VP2785-4K, a 27-inch 4K UHD (3840×2160) monitor that delivers precise and consistent color representation and performance to ensure incredible image quality. Built... Read more
Apple now offering Certified Refurbished 2017...
Apple is now offering Certified Refurbished 2017 27″ iMacs for up to $350 off original MSRP. Apple’s one-year warranty is standard, and shipping is free. The following models are available: – 27″ 3.... Read more
13-inch 2.3GHz MacBook Pros on sale for $100...
Amazon has the new 2017 13″ 2.3GHz MacBook Pros on sale today for $100 off MSRP, each including free shipping: – 13″ 2.3GHz/128GB Space Gray MacBook Pro (MPXQ2LL/A): $1199.99 $100 off MSRP – 13″ 2.... Read more
Clearance 2016 13-inch MacBook Airs available...
B&H Photo has clearance 2016 13″ MacBook Airs available for up to $200 off original MSRP. Shipping is free, and B&H charges NY & NJ sales tax only: – 13″ 1.6GHz/128GB MacBook Air (MMGF2LL... Read more
Clearance 21-inch and 27-inch iMacs available...
B&H Photo has clearance 21″ and 27″ Apple iMacs available for up to $500 off original MSRP, each including free shipping plus NY & NJ sales tax only: – 27″ 3.3GHz iMac 5K: $1799 $500 off... Read more
New iOS 11 Productivity Features Welcome But...
The iOS community is in late summer holding mode awaiting the September arrival of the iPhone 8 and iOS 11. iOS 11 public betas have been available for months — number six was released this week —... Read more
Samsung Electronics Launches New Portable SSD...
Samsung Electronics America, Inc. has announced the launch of Samsung Portable SSD T5 – its newest portable solid state drive (PSSD) that raises the bar for the performance of external memory... Read more

Jobs Board

Development Operations and Site Reliability E...
Development Operations and Site Reliability Engineer, Apple Payment Gateway Job Number: 57572631 Santa Clara Valley, California, United States Posted: Jul. 27, 2017 Read more
Frameworks Engineering Manager, *Apple* Wat...
Frameworks Engineering Manager, Apple Watch Job Number: 41632321 Santa Clara Valley, California, United States Posted: Jun. 15, 2017 Weekly Hours: 40.00 Job Summary Read more
Map Quality Analyst Lead, *Apple* Maps Eval...
…a team of subject matter experts measuring the quality of a range of Apple Maps algorithms, such as Map search, recommendations, and routing. Our group works with Read more
Business Development Manager, *Apple* Pay -...
Job Summary Apple Pay is seeking an experienced Business Development professional to join the Apple Pay team to develop partnerships and strategic alliances with Read more
Information Systems Engineer, *Apple* Retai...
Job Summary Do you have a passion for the technology and systems that make Apple amazing? Are you interested in joining IS&T Retail on what they do best? This is an Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.