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 );
 }
}

 
AAPL
$101.58
Apple Inc.
+0.72
MSFT
$46.52
Microsoft Corpora
-0.24
GOOG
$584.77
Google Inc.
+4.82

MacTech Search:
Community Search:

Software Updates via MacUpdate

Apple Configurator 1.6 - Configure and d...
Apple Configurator makes it easy for anyone to mass configure and deploy iPhone, iPad, and iPod touch in a school, business, or institution. Three simple workflows let you prepare new iOS devices... Read more
SpamSieve 2.9.16 - Robust spam filter fo...
SpamSieve is a robust spam filter for major email clients that uses powerful Bayesian spam filtering. SpamSieve understands what your spam looks like in order to block it all, but also learns what... Read more
OS X Server 3.2.1 - For OS X 10.9.5 Mave...
OS X Server is the next generation of Apple's award winning server software. Designed for OS X and iOS devices, OS X Server makes it easy to share files, schedule meetings, synchronize contacts, host... Read more
Apple Security Update 2014-004 - For OS...
Apple Security Update is recommended for all users and improves the security of Mac OS X. For information on the security content of this update, please visit this website: http://support.apple.com/... Read more
OS X Mavericks 10.9.5 - The latest versi...
Apple OS X Mavericks is the latest release of the world's most advanced desktop operating system. Now free! With more than 200 new features, OS X Mavericks brings Maps and iBooks to the Mac,... Read more
iExplorer 3.5.0.0 - View and transfer al...
iExplorer is an iPhone browser for Mac lets you view the files on your iOS device. By using a drag and drop interface, you can quickly copy files and folders between your Mac and your iPhone or... Read more
BusyCal 2.6 - Powerful calendar app with...
BusyCal is an award-winning desktop calendar that combines personal productivity features for individuals with powerful calendar sharing capabilities for families and workgroups. BusyCal's unique... Read more
Apple iOS 8.0 - The latest version of Ap...
The latest version of iOS can be downloaded through iTunes. Apple iOS 8 comes with big updates to apps you use every day, like Messages and Photos. A whole new way to share content with your family.... Read more
Apple Digital Camera RAW Compatibility 5...
Apple Digital Camera RAW Compatibility update adds RAW image compatibility to Aperture 3 and iPhoto '11. For more information on supported RAW formats, see here.Version 5.07: Adds RAW camera... Read more
Transmit 4.4.7 - Excellent FTP/SFTP clie...
Transmit is an excellent FTP (file transfer protocol), SFTP, S3 (Amazon.com file hosting) and iDisk/WebDAV client that allows you to upload, download, and delete files over the internet. With the... Read more

Latest Forum Discussions

See All

Paste+ | Clipboard Action Widget (Produ...
Paste+ | Clipboard Action Widget 1.0.0 Device: iOS iPhone Category: Productivity Price: $3.99, Version: 1.0.0 (iTunes) Description: Powerful clipboard widget for iOS 8. Reimagine what you can do with your clipboard! Paste+ is a... | Read more »
Agenda+ | Calendar & Reminder Widget...
Agenda+ | Calendar & Reminder Widget 1.0.0 Device: iOS iPhone Category: Productivity Price: $1.99, Version: 1.0.0 (iTunes) Description: Best Calendar and Reminder Widget Ever for iOS 8 | Read more »
Leg·end·ar·y (Games)
Leg·end·ar·y 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Simple and yet complex. Leg•end•dar•y is a grid-based puzzle game based on numbers. Discover the adventure of Leg•end•dar•y and... | Read more »
KuaiBoard (formerly QuickBoard) (Utilit...
KuaiBoard (formerly QuickBoard) 1.0 Device: iOS Universal Category: Utilities Price: $1.99, Version: 1.0 (iTunes) Description: KuaiBoard is currently 50% off for launch! Billing info. Signatures. Locations. KuaiBoard allows you to... | Read more »
Treasure Fetch - Adventure Time (Games)
Treasure Fetch - Adventure Time 1.0.1 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.1 (iTunes) Description: Adventure Time Treasure Fetch is a fresh take on the classic Snake game! STRETCHY JAKE Snake your way... | Read more »
Light in the Dark (Games)
Light in the Dark 1.1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.1.0 (iTunes) Description: Be enlightened by this delightful puzzle game that has never before seen the light of day! "A physics and color-blending... | Read more »
Transmit iOS (Utilities)
Transmit iOS 1.0 Device: iOS Universal Category: Utilities Price: $9.99, Version: 1.0 (iTunes) Description: >> LAUNCH SPECIAL: Transmit iOS is ONLY $10 for a LIMITED TIME. << THE #1 FILE TRANSFER CLIENT FOR THE MAC NOW... | Read more »
Minuum - The Little Keyboard for Big Fin...
Minuum - The Little Keyboard for Big Fingers 1.0 Device: iOS iPhone Category: Utilities Price: $1.99, Version: 1.0 (iTunes) Description: Type faster, see more of your screen, and take control of autocorrect with Minuum: the little... | Read more »
TextExpander 3 + custom keyboard (Utili...
TextExpander 3 + custom keyboard 3.0 Device: iOS Universal Category: Utilities Price: $4.99, Version: 3.0 (iTunes) Description: | Read more »
Swype - Keyboard (Utilities)
Swype - Keyboard 1.0.1411 Device: iOS Universal Category: Utilities Price: $.99, Version: 1.0.1411 (iTunes) Description: Why type when you can Swype? One of the most requested apps for iPhone is finally here. "If Swype itself ever... | Read more »

Price Scanner via MacPrices.net

Toshiba Introduces TransMemory ID High-Speed...
Toshiba’s Digital Products Division (DPD), a division of Toshiba America Information Systems, Inc., today introduced the TransMemory ID USB 3.0 Flash Drive, a simpler storage solution for people who... Read more
New iPads and OS X Yosemite Release Coming Oc...
The DailyDot’s Micah Singleton reports that Apple is planning to hold its next product announcement event on Oct. 21, at which it will unveil the iPad Air 2 and iPad mini 3 and release a final build... Read more
Logitech Bluetooth Multi-Device Cross-Platfor...
Logitech has an enviable track record of making some of the best computer keyboards and mice. At least in my estimation, the best freestanding keyboards I’ve ever used have been Logitech units,... Read more
Roundup of Apple refurbished iPad Airs and iP...
Apple is offering Certified Refurbished iPad Airs for up to $140 off MSRP. Apple’s one-year warranty is included with each model, and shipping is free. Stock tends to come and go with some of these... Read more
Sprint offers 16GB iPad mini for $199.99 with...
Sprint is offering 1st generation 16GB iPad minis for $199.99 with a 2-year service agreement. Standard MSRP for this iPad is $429. Their price is the lowest available for this model. Read more
2.5GHz Mac mini remains on sale for $549, sav...
B&H Photo has the 2.5GHz Mac mini on sale for $549.99 including free shipping. That’s $50 off MSRP, and B&H will also include a free copy of Parallels Desktop software. NY sales tax only. Read more
Apple refurbished iMacs available for up to $...
The Apple Store has Apple Certified Refurbished iMacs available for up to $300 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free. These are the best prices on... Read more
13″ 2.5GHz MacBook Pro offered for $100 off M...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $999.99 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Read more
Free GIMP Professional Grade Graphics App Ver...
The latest 2.8.14 version of the oddly-named GIMP (acronym for: GNU Image Manipulation Program) open source, high-end image editing and creation alternative to Adobe’s Photoshop and refuge from... Read more
Apple Announces Record Pre-orders for iPhone...
Apple has released metrics showing a record number of first day pre-orders of iPhone 6 and iPhone 6 Plus, with over four million sold in the first 24 hours. Demand for the new iPhones exceeds the... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.