TweetFollow Us on Twitter

HFS Tree Climb
Volume Number:5
Issue Number:8
Column Tag:HyperChat™

Related Info: File Manager Standard File

XCMD Corner: HFS Tree Climbing

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.

Hyper Lite

In keeping with the spirit of the summer season, this month’s XCMD is light and easy. Not too long ago, I promised to provide an XCMD that, given the name and directory id of a file, returned that file’s full pathname. Such a utility is eminently useful in the current incantation of Hypercard.

Hypercard is fully capable of opening a file, reading and writing its contents and then closing the file. Unfortunately, unless you know the full path name of the file, you are limited to accessing files in Hypercard’s working directory.

One of the first published XCMDs was a little gem from Steve Maller of Apple Computer Inc. that eliminates this MSDOS-compatible feature of Hypercard. Steve’s FileName.p presents the user with the standard file package and returns the full pathname of the file specified.

If you are a regular reader of this column, you’ll recall that I translated Steve’s XCMD from pascal to “C”. You also know that my version lost something in the translation. Rather than return a full pathname, GetFileName.c returns the file’s name and working directory id. I felt this was more useful because the file’s name and wdid open up access to most of the file manager calls for the XCMD programmer. Still, if you want to continue to use Hypercard’s built-in file I/O, getfileName won’t be of much use since it doesn’t return the full pathname required by hypercard.

Listing 1 (FullPathName.c) is a simple XCMD that accepts the filename and working directory id as input and returns the fullpathname of the file as output.

As is often the case, this XCMD first converts the input data from c-string format to pascal strings and numbers as needed. Note that the default return value will be the name of the file that was passed in param[0].

A Review of HFS

As a rule, we don’t come into contact with full pathnames very often on the Macintosh so the format may require a little explaining. If you want to explore the Hierarchical File System in greater detail, take the time to read Chapter 19 of volume IV of Inside Macintosh. If you don’t have volume IV handy, the following discussion will get help you understand the code.

Devices that can store and retrieve data on the Macintosh are called “volumes”. Files are organized on volumes in folders. Folders can contain other folders yielding a hierarchical or “Tree structure”. The order in which folders are stored in this tree structure specify a path to any file that is contained in that folder.

The root of this tree is the volume name. If we stick a “:” onto the end of the volume name, we have the beginning of a full pathname. In other words full pathnames always start with the volume name. Each path in the pathname is delineated by the “:”. Thus, Hd:folder:file specifies a valid pathname. The last item in the pathname is the name of the file itself. The folder that holds this file is referred to by a unique directory id. When the user selects a file using SFGetFile or SFPutFile, the file manager returns the file’s name as well as the directory id. For historical purposes, the directory id is stored in the vRefNum field of the reply record. This little tweak is how Apple was able to make HFS backward compatible with the flat-file system.

Tree Climbing

The folder that contains the file represents the deepest node on the tree. The next folder up the hierarchy is called the parent. Knowing the parent’s id, we can call PBGetCatInfo to get its name as well as the directory id of its parent folder. We climb the tree by continuously feeding a parent directory id into PBGetCatInfo until we detect an error (no more folders on this path).

Tree climbing suggests recursion. The routine ClimbTree in Listing 1 calls PBGetCatInfo to get information about the directory whose id was passed in. We kick it off by first getting information about the folder that holds the file. This is the directory whose id was returned in the reply record.

Each activation of climbTree uses the same catalog parameter block (cpb) which was allocated in the stack frame of FullPathName. This is legal because the only information that is unique to each activation is the directory id (passed as a parameter in child) as well as a pointer to the string the PBGetCatInfo uses to store the folder’s name. Each activation allocates memory for the name string and sets cpb’s ioNamePtr field to point to its own copy of the string.

I allocate the string, folder_name, in the heap and point to it on the stack because successful recursion dictates that one be mindful of the stack at all times. Even if there is no danger of overflowing the stack, a little defensive programming goes a long way.

A nice feature of the recursion is that we can build the string in forward order. Although we walked the tree backwards, we don’t actually put the full pathname together until we reach the root which is detected by discovering that it has no parent folder. Once we reach the root, the stack unwinds in the order of root->parent->child->filename.

The following script, working with GetFileName.c (See Mactutor Vol. 5 No. 6) returns the full pathname of a file selected via standard dialog:

--1

on mouseup
 put getfilenametoOpen() into it
 if item 1 of it is not empty then
 put Fullpathname(item 1 of it, item 2 of it) into it
  end if
end mouseup

Because Hierarchical File System can’t handle pathnames longer than 256 characters, I limit the string returned by Fullpathname to 256 characters. If you want to return the full path regardless of length, you can modify the concat routine in “HyperUtils.c” to “grow” the output string on demand.

Listing:  FullPathName.c
/********************************/
/* File: FullPathName.c   */
/* Given the name and working */
/* directory of a file, walk the*/
/* directory tree to determine*/
/* what the full pathname of the*/
/* directory is... */
/* Paramters:    */
/* param0 = file namenum  */
/* param1 = directory id  */
/* Out: */
/* full pathname of the working  */
/* directory   */
/* Once again, I am indepbted to*/
/* Steve Maller of Apple  */
/* Computer Inc for illuminating*/
/* this oft too dark realm of */
/* the toolbox.  */
/********************************/
#include<MacTypes.h>
#include<OSUtil.h>
#include<MemoryMgr.h>
#include<FileMgr.h>
#include<ResourceMgr.h>
#include<pascal.h>
#include<strings.h>
#include<hfs.h>
#include  “HyperXCmd.h”
#include“HyperUtils.h”
#define nil 0L

char    colon[2] = “\p:”;

void ClimbTree( child, cpb, fullName )
 long   child;
 CInfoPBPtr cpb;
 char   *fullName;
/*************************
* Climb the directory tree
* until we reach the root
* Allocate the records in the
* heap to keep the stack frame
* as small as necessary.  Too
* large a stack frame can 
* lead to a case of terminal
* terminal.
* child is the working directory
* id of the “current folder”, vol
* is the volume reference number and
* fullName points to the 
* output string
*************************/
{
 StringPtrfolder_name= (StringPtr)NewPtr( 256 );
/*** setting the file directory index to -1***/
/*** lets us get information about the ***/
/*** directory whose id is specified inthe***/
/*** ioDrDIrID field of the parameter block***/
 folder_name[0] = ‘\0’; 
 cpb->dirInfo.ioNamePtr   = (StringPtr)folder_name;
 cpb->dirInfo.ioDrDirID   = child; 

 if( PBGetCatInfo( cpb, 0) == noErr ){
 ClimbTree(cpb->dirInfo.ioDrParID,cpb,fullName);

 Concat( (char *)fullName, (char *)folder_name );
 Concat( (char *)fullName, (char *)&colon );
 }
 DisposPtr( folder_name   );
 
}

pascal void main( paramPtr )
 XCmdBlockPtr  paramPtr;
{
 Str31  str,fName;
 short  wdid;
 WDPBRectheWDPB;
 CInfoPBRec theCPB;
 HParamBlockRec  theHPB;
 char   fullPath[256];
 char   part_Name[256]; /*** used in HPB     ***/
 char   vol_Name[256];
 OSErr  err;

 colon[0] = 1;
 colon[1] = ‘:’;
 
 vol_Name[0] = ‘\0’;
 part_Name[0]= ‘\0’;
 /*** empty is the default answer ***/
 paramPtr->returnValue = 0L;

 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 = StrToNum( paramPtr, &str );
 
 /*** First, we appeal to GetVInfo to get    ***/
 /*** volume name that the file lives on     ***/
 part_Name[0]    = ‘\0’;  
 theHPB.volumeParam.ioNamePtr = (StringPtr)vol_Name;     
 theHPB.volumeParam.ioVRefNum = (short)wdid;             
 theHPB.volumeParam.ioVolIndex   = 0;  
 if(PBHGetVInfo( &theHPB, 0) != noErr )
 return;  

 /*** Next, use the working directory info   ***/
 /*** to walk the directory tree backwards   ***/
 /*** to the root directory ***/
 theWDPB.ioNamePtr = (StringPtr)part_Name;
 theWDPB.ioVRefNum = wdid;  
 theWDPB.ioWDProcID= 0;   
 theWDPB.ioWDIndex = 0;   
 if( PBGetWDInfo( &theWDPB, 0) != noErr )    
 return;
 
 fullPath[0] = ‘\0’; 
 theCPB.dirInfo.ioFDirIndex = -1; 
 theCPB.dirInfo.ioVRefNum = theHPB.volumeParam.ioVRefNum;      
 
 ClimbTree( theWDPB.ioWDDirID, 
 (CInfoPBPtr)&theCPB, 
 (StringPtr)fullPath );
 
 /*** Climbing the tree yields the names of  ***/
 /*** all the folders which we still need to ***/
 /*** add the file’s name to. ***/
 Concat( (char *)fullPath, (char *)&fName );
 paramPtr->returnValue = PasToZero( paramPtr, fullPath );
}
Listing:  HyperUtils.H
/********************************/
/* HyperUtils.H  */
/* Header file for HyperUtils.c  */
/* routines...   */
/********************************/
#define NIL 0L
#define UPFRONT  -1L
void  CenterWindow( WindowPtr wptr );
void  Concat( char * str1, char * str2 );
void  CopyPStr( char * pStr1, char * pStr2 );
short GetFileNameToOpen(SFTypeList typs,short typcnt, char *theName, 
short *theWDID);
Listing:  HyperUtils.c
/****************************/
/* HyperUtils.c  */
/* A collection of useful */
/* routines...   */
/****************************/
#include<MacTypes.h>
#include<OSUtil.h>
#include<MemoryMgr.h>
#include<FileMgr.h>
#include<ResourceMgr.h>
#include<StdFilePkg.h>
#include  “HyperXCmd.h”
#include  “HyperUtils.h”

void  CenterWindow( wptr )
 WindowPtrwptr;
/***************************
* Center a window in the current
* screen port.  Note: Does not
* attempt to work with multi-screen
* systems.
* This code is inspired by a
* similar routine written by Steve
* Maller in MPW Pascal.  Thanks Steve.
***************************/
{
 short  hWindSize = wptr->portRect.right - wptr->portRect.left;
 short  vWindSize = wptr->portRect.bottom - wptr->portRect.top;
 short  hSize = wptr->portBits.bounds.right - wptr->portBits.bounds.left;
 short  vSize = wptr->portBits.bounds.bottom - wptr->portBits.bounds.top;
 
 MoveWindow( wptr, ( hSize - hWindSize ) / 2, 
 ( vSize - vWindSize + 20) / 2, false);
}

void Concat( str1, str2 )
 char *str1;
 char *str2;
/*****************************
* Append string 2 to the end of
* string 1.  Both strings are 
* pascal-format strings.
* str1 must be large enough to hold
* the new string and is assumed to 
* be of Type Str255 (a pascal string)
*****************************/
{
 short len1 = *str1;/***number of chars in string 1***/
 short len2 = *str2++;/*** number of chars in string 2***/
 char  *temp;    /*** string pointer ***/
 
 if( len1 +len2  > 255 )
 len2 = 255 - len1;
 *str1++ += len2 ; /***add sizes together to get new size***/
 temp = str1 + len1;/*** move to end of string 1***/
 while( len2 ){
 *temp++ = *str2++;/*** add char to temp and move along***/
 --len2;/*** until all characters are added***/
 }
}

void  CopyPStr( pStr1, pStr2 )
 char *pStr1;
 char *pStr2;
/****************************
* Copy the contents of pstr1 into
* pstr2.  The strings are assumed 
* to be of type STR255 (length byte
* precedes data 
****************************/
{short  i;
 char *tstr;
 
 tstr = pStr2; 
 for( i = 0; i <= *pStr1; i++ )
 *tstr++ = *pStr1++;
}

short GetFileNameToOpen( typs, typCnt,theName, theWDID )
 SFTypeList typs; short   typCnt;
 char   *theName; short   *theWDID;
/*****************************
* Invokes SFOpenFile to query the 
* user for the name of a file to open.  
* In:   List of types of files to
*filter for (up to 4)
* Out:  fileName if picked in theName
*working directory in theWDID
*nil otherwise
*the file’s volum ref num.
* ( Note that the space for the 
* string must be allocated by the
* caller).
*****************************/
{
 Point  where;
 char   prompt[1];
 SFReplyreply;
 GrafPort *oldPort;
 WindowPtrdlogID;
 prompt[0]  = ‘\0’;
 /*** Get and put up the standard file ***/
 /*** dialog.  You will only see the file***/
 /*** types that you filtered for.  If ***/
 /*** you filtered for no files, then  ***/
 /*** all files will display***/
 GetPort( &oldPort );
 dlogID = GetNewDialog( (short)getDlgID, (Ptr)NIL, (Ptr)UPFRONT );
 SetPort( dlogID );
 CenterWindow( dlogID );
 where.h = dlogID->portRect.left;
 where.v = dlogID->portRect.top;
 LocalToGlobal( &where );
 SFGetFile( where, prompt, (Ptr)NIL, typCnt, typs, (Ptr)NIL, &reply );
 DisposDialog( dlogID );
 SetPort( oldPort );
 /*** If the user selected a file, let’s ***/
 /*** get the information about it ***/
 if (reply.good){
 *theWDID = reply.vRefNum;
 PtoCstr( (char *)&reply.fName );
 strcpy( theName, &reply.fName  );
 }
 return( reply.good );
}

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Sublime Text 3126 - Sophisticated text e...
Sublime Text is a sophisticated text editor for code, markup, and prose. You'll love the slick user interface, extraordinary features, and amazing performance. Features Goto Anything. Use Goto... Read more
1Password 6.3.3 - Powerful password mana...
1Password is a password manager that uniquely brings you both security and convenience. It is the only program that provides anti-phishing protection and goes beyond password management by adding Web... Read more
WhatsApp 0.2.1880 - Desktop client for W...
WhatsApp is the desktop client for WhatsApp Messenger, a cross-platform mobile messaging app which allows you to exchange messages without having to pay for SMS. WhatsApp Messenger is available for... Read more
NeoFinder 6.9.3 - Catalog your external...
NeoFinder (formerly CDFinder) rapidly organizes your data, either on external or internal disks, or any other volumes. It catalogs all your data, so you stay in control of your data archive or disk... Read more
Amadeus Pro 2.3.1 - Multitrack sound rec...
Amadeus Pro lets you use your Mac computer for any audio-related task, such as live audio recording, digitizing tapes and records, converting between a variety of sound formats, etc. Thanks to its... Read more
Yasu 4.0.0 β - System maintenance app; p...
Yasu was created with System Administrators who service large groups of workstations in mind, Yasu (Yet Another System Utility) was made to do a specific group of maintenance tasks quickly within a... Read more
Hazel 4.0.6 - Create rules for organizin...
Hazel is your personal housekeeper, organizing and cleaning folders based on rules you define. Hazel can also manage your trash and uninstall your applications. Organize your files using a familiar... Read more
EtreCheck 3.0.5 - For troubleshooting yo...
EtreCheck is an app that displays the important details of your system configuration and allow you to copy that information to the Clipboard. It is meant to be used with Apple Support Communities to... Read more
Skype 7.37.0.178 - Voice-over-internet p...
Skype allows you to talk to friends, family and co-workers across the Internet without the inconvenience of long distance telephone charges. Using peer-to-peer data transmission technology, Skype... Read more
Yasu 4.0.0 β - System maintenance app; p...
Yasu was created with System Administrators who service large groups of workstations in mind, Yasu (Yet Another System Utility) was made to do a specific group of maintenance tasks quickly within a... Read more

How to get past Vulture Island's tr...
Vulture Island is a colorful and quirky mish-mash of platforming and puzzles. It’s creative and fresh, but sometimes the game can throw a curveball at you, leaving you stuck as to how you should progress. These tips will help you explore smoothly... | Read more »
The new Clash of Kings is just for Weste...
If you’ve played the original Clash of Kings, you’ll probably recognise the city building, alliance forging and strategic battles in Clash of Kings: The West. What sets this version apart is that it’s tailor made for a Western audience and the... | Read more »
Frost - Survival card game (Games)
Frost - Survival card game 1.12.1 Device: iOS Universal Category: Games Price: $3.99, Version: 1.12.1 (iTunes) Description: *Warning: the game will work on iPhone 5C and above and iPad Pro / 4. Other devices are not supported* | Read more »
How to build and care for your team in D...
Before you hit the trail and become a dog sledding legend, there’s actually a fair bit of prep work to be done. In Dog Sled Saga, you’re not only racing, you’re also building and caring for a team of furry friends. There’s a lot to consider—... | Read more »
How to win every race in Dog Sled Saga
If I had to guess, I’d say Dog Sled Saga is the most adorable racing game on the App Store right now. It’s a dog sled racing sim full of adorable, loyal puppies. Just look at those fluffy little tails wagging. Behind that cute, pixelated facade is... | Read more »
Let the war games commence in Gunship Ba...
Buzz Lightyear famously said, “This isn’t flying, this is falling – with style!” In the case of Gunship Battle: Second War, though, this really is flying - with style! The flight simulator app from Joycity puts you in control of 20 faithfully... | Read more »
How to get a high score in Fired Up
Fired Up is Noodlecake Games’ high score chasing, firefighting adventure. You take control of a wayward firefighter who propels himself up the side of a highrise with blasts of water. Sound silly? It is. It’s also pretty difficult. You can’t... | Read more »
NBA 2K17 (Games)
NBA 2K17 1.0 Device: iOS iPhone Category: Games Price: $7.99, Version: 1.0 (iTunes) Description: Following the record-breaking launch of NBA 2K16, the NBA 2K franchise continues to stake its claim as the most authentic sports video... | Read more »
Dog Sled Saga (Games)
Dog Sled Saga 1.0.1 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0.1 (iTunes) Description: A game by Dan + Lisa As a rookie musher, foster a dogsledding team whose skills will grow if they're treated right. Week by... | Read more »
60 Seconds! Atomic Adventure (Games)
60 Seconds! Atomic Adventure 1.2 Device: iOS Universal Category: Games Price: $2.99, Version: 1.2 (iTunes) Description: 60 Seconds! is a dark comedy atomic adventure of scavenge and survival. Collect supplies and rescue your family... | Read more »

Price Scanner via MacPrices.net

21-inch iMacs on sale for up to $120 off MSRP
B&H Photo has 21″ iMacs on sale for up to $120 off MSRP including free shipping plus NY sales tax only: - 21″ 3.1GHz iMac 4K: $1379 $120 off MSRP - 21″ 2.8GHz iMac: $1199.99 $100 off MSRP - 21″ 1... Read more
13-inch 2.7GHz/256GB Retina MacBook Pro on sa...
Amazon.com has the 13″ 2.7GHz/256GB Retina Apple MacBook Pro on sale for $151 off MSRP including free shipping: - 13″ 2.7GHz/256GB Retina MacBook Pro (sku MF840LL/A): $1348 $151 off MSRP Read more
Apple TVs on sale for up to $50 off MSRP
Best Buy has 32GB and 64GB Apple TVs on sale for $40-$50 off MSRP on their online store. Choose free shipping or free local store pickup (if available). Sale prices for online orders only, in-store... Read more
Apple refurbished 13-inch Retina MacBook Pros...
Apple has Certified Refurbished 13″ Retina MacBook Pros available for up to $270 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: - 13″ 2.7GHz... Read more
Duplicate Sweeper Free On Mac App Store For O...
To celebrate the launch of Apple’s latest macOS Sierra, Stafford, United Kingdom based Wide Angle Software has announced that its duplicate file finder software, Duplicate Sweeper, is now available... Read more
13-inch Retina MacBook Pros on sale for up to...
B&H Photo has 13″ Retina Apple MacBook Pros on sale for up to $150 off MSRP. Shipping is free, and B&H charges NY tax only: - 13″ 2.7GHz/128GB Retina MacBook Pro: $1174.99 $125 off MSRP - 13... Read more
Evidence Surfaces Pointing To New A10X Chip F...
Citing a job description for a Project Lead position at Apple’s Austin, Texas engineering labs, Motley Fool’s Ashraf Eassa deduces that development is progressing well on Apple’s next-generation in-... Read more
Check Print’R for macOS Allows Anyone to Easi...
Delaware-based Match Software has announced the release and immediate availability of Check Print’R 3.21, an important update to their easy-to-use check printing application for macOS. Check Print’R... Read more
Apple refurbished 11-inch MacBook Airs availa...
Apple has Certified Refurbished 11″ MacBook Airs (the latest models), available for up to $170 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is... Read more
Apple refurbished 15-inch Retina MacBook Pros...
Apple has Certified Refurbished 2015 15″ Retina MacBook Pros available for up to $380 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: - 15″ 2... Read more

Jobs Board

Sr. *Apple* Mac Engineer - Net2Source Inc....
…staffing, training and technology. We have following position open with our client. Sr. Apple Mac Engineer6+ Months CTH Start date : 19th Sept Travelling Job If Read more
*Apple* Retail - Multiple Positions-Norfolk,...
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
Lead *Apple* Solutions Consultant - Apple (...
# Lead Apple Solutions Consultant Job Number: 51829230 Detroit, Michigan, United States Posted: Sep. 19, 2016 Weekly Hours: 40.00 **Job Summary** The Lead ASC is an Read more
US- *Apple* Store Leader Program - Apple (Un...
…Summary Learn and grow as you explore the art of leadership at the Apple Store. You'll master our retail business inside and out through training, hands-on Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.