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

A beginner's guide to Spellbinders
Spellbinderslooks a heck of a lot like Clash Royale, but has an entirely different pace to it. As such, it can be difficult to adjust to. Just in case you've been playing way too much Clash Royale (and who hasn't), we've put together a bunch of... | Read more »
Camping With Grandpa (Education)
Camping With Grandpa 1.0 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0 (iTunes) Description: | Read more »
Black Hole Joyrider (Games)
Black Hole Joyrider 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Guide your spacecraft through the gravity well of a powerful black hole using only your retro-thrusters and dwindling fuel... | Read more »
My Koi (Games)
My Koi 1.0 Device: iOS iPhone Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: My Koi is a beautiful and relaxing fish pond app. Customise and name each fish. Feed them daily. Watch them grow. Collect new fish.... | Read more »
Never Gone (Games)
Never Gone 1.0.2 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.2 (iTunes) Description: ###IMPPORTANT### Never Gone's HD art resources require devices with more than 1GB RAM, so please note that iPhone 4/4s, iPad 2/... | Read more »
INKS. (Games)
INKS. 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: From the makers of BAFTA-winning Lumino City comes INKS. INKS updates pinball for a new generation. It combines the joy of pinball with... | Read more »
How to maximise your profits in Bakery B...
Running a bakery can be an expensive venture. You’ll need to continuously upgrade your oven, your kitchen supplies, and even your ingredients to keep customers happy. Most of these renovations in Bakery Blitz cost a pretty penny, but we have a few... | Read more »
How to manage your time in Bakery Blitz
It can be tricky, especially when you risk burning your kitchen to the ground if you forget a cake in the oven, so make sure to use these time management tricks to keep your bakery running smoothly. Don’t collect the money right away [Read more] | Read more »
Model 15 (Music)
Model 15 1.0 Device: iOS iPhone Category: Music Price: $29.99, Version: 1.0 (iTunes) Description: The Moog Model 15 App is the first Moog modular synthesizer and synthesis educational tool created exclusively for iPad, iPhone and... | Read more »
How to deal with wind in Angry Birds Act...
Angry Birds Action! is a physics-based puzzler in which you're tasked with dragging and launching birds around an obstacle-littered field to achieve a set objective. It's simple enough at first, but when wind gets introduced things can get pretty... | Read more »

Price Scanner via MacPrices.net

Hybrid Tablets Meet Rising Demand for a Singl...
Rising demand for a new breed of hybrid tablets — 2 in 1 devices that function as either a laptop or a tablet — is shaking up the tablet market and contributing to a shift in the way owners are... Read more
Bausch + Lomb and IBM Collaborate on iPhone...
Global eye health company Bausch + Lomb, and IBM on Thursday announced a collaboration to develop the first app of its kind for iPhone and iPad for surgeons who perform cataract surgery. The... Read more
Apple & SAP Partner to Deliver New iOS Ap...
Apple and Walldorf, Germany based SAP have announced a partnership to revolutionize the mobile work experience for enterprise customers of all sizes, combining powerful native apps for iPhone and... Read more
New 12-inch 1.1GHz Rose Gold Retina MacBook o...
B&H Photo has the new 2016 12″ 1.1GHz/256GB Rose Gold Retina MacBook (sku MMGL2LL/A) on sale for $1199 including free shipping plus NY tax only. Their price is $100 off MSRP, and it’s the lowest... Read more
12-inch 128GB iPad Pros on sale for up to $10...
B&H Photo has 12″ 128GB WiFi iPad Pros on sale for up to $100 off MSRP, each including free shipping. B&H charges sales tax in NY only: - 12″ Space Gray 128GB WiFi iPad Pro: $899 $50 off MSRP... Read more
Global Tablet Sales Slump Continues, iPad’s F...
Another miserable showing for the global slate tablet category in calendar Q1/16, with global tablet shipments falling another 1ten percent to 46.5 million units during the according to Strategy... Read more
Revel Systems to Showcase iPad POS Platform w...
Revel Systems, specialists in iPad Point of Sale management solution for brick-and-mortar retail, food businesses and more, today announced that it will showcase its innovative iPad Point of Sale... Read more
13-inch 2.5GHz MacBook Pro on sale for $999,...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $999 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Read more
Apple refurbished 2015 iMacs available for up...
Apple now has a full line of Certified Refurbished 2015 21″ & 27″ iMacs available for up to $350 off MSRP. Apple’s one-year warranty is standard, and shipping is free. The following models are... Read more
Indian Smartphone Market Grows Annually by 12...
India’s smartphone market grew by 12 percent year-over-year, with 24.4 million units shipping in Q1 2016. The top five vendors stayed the same, with Samsung in the lead, followed by Micromax, Intex... Read more

Jobs Board

*Apple* Support Technician II - Worldventure...
…global, fast growing member based travel company, is currently sourcing for an Apple Support Technician II to be based in our Plano headquarters. WorldVentures is Read more
*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
Automotive Sales Consultant - Apple Ford Linc...
…you. The best candidates are smart, technologically savvy and are customer focused. Apple Ford Lincoln Apple Valley is different, because: $30,000 annual salary Read more
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.