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

NetShade 6.3.1 - Browse privately using...
NetShade is an anonymous proxy and VPN app+service for Mac. Unblock your Internet through NetShade's high-speed proxy and VPN servers spanning seven countries. NetShade masks your IP address as you... Read more
Dragon Dictate 4.0.7 - Premium voice-rec...
With Dragon Dictate speech recognition software, you can use your voice to create and edit text or interact with your favorite Mac applications. Far more than just speech-to-text, Dragon Dictate lets... Read more
Persecond 1.0.2 - Timelapse video made e...
Persecond is the easy, fun way to create a beautiful timelapse video. Import an image sequence from any camera, trim the length of your video, adjust the speed and playback direction, and you’re done... Read more
GIMP 2.8.14p2 - Powerful, free image edi...
GIMP is a multi-platform photo manipulation tool. GIMP is an acronym for GNU Image Manipulation Program. The GIMP is suitable for a variety of image manipulation tasks, including photo retouching,... Read more
Sandvox 2.10.2 - Easily build eye-catchi...
Sandvox is for Mac users who want to create a professional looking website quickly and easily. With Sandvox, you don't need to be a Web genius to build a stylish, feature-rich, standards-compliant... Read more
LibreOffice 5.0.1.2 - Free, open-source...
LibreOffice is an office suite (word processor, spreadsheet, presentations, drawing tool) compatible with other major office suites. The Document Foundation is coordinating development and... Read more
f.lux 36.1 - Adjusts the color of your d...
f.lux makes the color of your computer's display adapt to the time of day, warm at night and like sunlight during the day. Ever notice how people texting at night have that eerie blue glow? Or wake... Read more
VirtualBox 5.0.2 - x86 virtualization so...
VirtualBox is a family of powerful x86 virtualization products for enterprise as well as home use. Not only is VirtualBox an extremely feature rich, high performance product for enterprise customers... Read more
File Juicer 4.43 - Extract images, video...
File Juicer is a drag-and-drop can opener and data archaeologist. Its specialty is to find and extract images, video, audio, or text from files which are hard to open in other ways. In computer... Read more
Apple MainStage 3.2 - Live performance t...
MainStage 3 makes it easy to bring to the stage all the same instruments and effects that you love in your recording. Everything from the Sound Library and Smart Controls you're familiar with from... Read more

ReBoard: Revolutionary Keyboard (Utilit...
ReBoard: Revolutionary Keyboard 1.0 Device: iOS Universal Category: Utilities Price: $1.99, Version: 1.0 (iTunes) Description: Do everything within the keyboard without switching apps! If you are in WhatsApp, how do you schedule a... | Read more »
Tiny Empire (Games)
Tiny Empire 1.1.3 Device: iOS Universal Category: Games Price: $2.99, Version: 1.1.3 (iTunes) Description: Launch cannonballs and blow tiny orcs into thousands of pieces in this intuitive fantasy-themed puzzle shooter! Embark on an... | Read more »
Astropad Mini (Productivity)
Astropad Mini 1.0 Device: iOS iPhone Category: Productivity Price: $4.99, Version: 1.0 (iTunes) Description: *** 50% off introductory price! ​*** Get the high-end experience of a Wacom tablet at a fraction of the price with Astropad... | Read more »
Emo Chorus (Music)
Emo Chorus 1.0.0 Device: iOS Universal Category: Music Price: $1.99, Version: 1.0.0 (iTunes) Description: Realistic Choir simulator ranging from simple Chorus emulation to full ensemble Choir with 128 members. ### introductory offer... | Read more »
Forest Spirit (Games)
Forest Spirit 1.0.5 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.5 (iTunes) Description: | Read more »
Ski Safari 2 (Games)
Ski Safari 2 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: The world's most fantastical, fun, family-friendly skiing game is back and better than ever! Play as Sven's sister Evana, share... | Read more »
Lara Croft GO (Games)
Lara Croft GO 1.0.47768 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.47768 (iTunes) Description: Lara Croft GO is a turn based puzzle-adventure set in a long-forgotten world. Explore the ruins of an ancient... | Read more »
Whispering Willows (Games)
Whispering Willows 1.23 Device: iOS Universal Category: Games Price: $4.99, Version: 1.23 (iTunes) Description: **LAUNCH SALE 50% OFF** - Whispering Willows is on sale for 50% off ($4.99) until September 9th. | Read more »
Calvino Noir (Games)
Calvino Noir 1.1 Device: iOS iPhone Category: Games Price: $3.99, Version: 1.1 (iTunes) Description: The film noir stealth game. Calvino Noir is the exploratory, sneaking adventure through the 1930s European criminal underworld.... | Read more »
Angel Sword (Games)
Angel Sword 1.0 Device: iOS Universal Category: Games Price: $6.99, Version: 1.0 (iTunes) Description: Prepare to adventure in the most epic full scale multiplayer 3D RPG for mobile! Experience amazing detailed graphics in full HD.... | Read more »

Price Scanner via MacPrices.net

Big Grips Lift Handle For iPad Air and iPad A...
KEM Ventures, Inc. which pioneered the extra-large, super-protective iPad case market with the introduction of Big Grips Frame and Stand in 2011, is launching Big Grips Lift featuring a new super-... Read more
Samsung Launches Galaxy Tab S2, Its Most Powe...
Samsung Electronics America, Inc. has announced the U.S. release of the Galaxy Tab S2, its thinnest, lightest, ultra-fast tablet. Blending form and function, elegant design and multitasking power,... Read more
Tablet Screen Sizes Expanding as iPad Pro App...
Larger screen sizes are gaining favor as the tablet transforms into a productivity device, with shipments growing 185 percent year-over-year in 2015. According to a new Strategy Analytics’ Tablet... Read more
Today Only: Save US$50 on Adobe Elements 13;...
Keep the memories. lose the distractions. Summer’s winding down and it’s time to turn almost perfect shots into picture perfect memories with Elements 13. And get the power to edit both photos and... Read more
1.4GHz Mac mini on sale for $449, save $50
Best Buy has the 1.4GHz Mac mini on sale for $50 off MSRP on their online store. Choose free shipping or free local store pickup (if available). Price for online orders only, in-store price may vary... Read more
12-inch 1.1GHz Gold MacBook on sale for $1149...
B&H Photo has the 12″ 1.1GHz Gold Retina MacBook on sale for $1149.99 including free shipping plus NY sales tax only. Their price is $150 off MSRP, and it’s the lowest price available for this... Read more
27-inch 3.3GHz 5K iMac on sale for $1849, sav...
Best Buy has the 27″ 3.3GHz 5K iMac on sale for $1849.99. Their price is $150 off MSRP, and it’s the lowest price available for this model. Choose free shipping or free local store pickup (if... Read more
Worldwide Tablet Shipments Expected to Declin...
Does Apple badly need a touchscreen convertible/hybrid laptop MacBook? Yes, judging from a new market forecast from the International Data Corporation (IDC) Worldwide Quarterly Tablet Tracker, which... Read more
Continued PC Shipment Shrinkage Expected Thro...
Worldwide PC shipments are expected to fall by -8.7 percent in 2015 and not stabilize until 2017, according to the latest International Data Corporation (IDC) Worldwide Quarterly PC Tracker data. The... Read more
Imminent iPhone 6s Announcement Leads To 103%...
NextWorth Solutions, with its online and in-store electronics trade-in programs including http://NextWorth.com, reports that it has experienced a 103 percent surge in quoted trade-in values over the... Read more

Jobs Board

*Apple* Retail Online Store: Customer Insigh...
**Job Summary** Apple Retail (Online Store) is seeking an experienced e-commerce analytics professional to join the Customer Insights Team. The Web e-Commerce Analyst Read more
*Apple* Music, Business Operations - Apple I...
Changing the world is all in a day039s work at Apple . If you love innovation, here039s your chance to make a career of it. You039ll work hard. But the job comes with Read more
WW *Apple* Retail Online Store: Customer In...
**Job Summary** The Apple Retail - Online Store is seeking an experienced web merchandising analytics professional to join the Customer Insights Team. The Web Read more
Senior Payments Security Manager - *Apple*...
**Job Summary** Apple , Inc. is looking for a highly motivated, innovative and hands-on senior payments security manager to join the Apple Pay security team. You will Read more
Software QA Engineer, *Apple* Pay Security...
**Job Summary** Imagine what you could do here. At Apple , great ideas have a way of becoming great products, services, and customer experiences very quickly. Bring Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.