TweetFollow Us on Twitter

November 91 - User Selected Folders & Indexing Through Directories

User Selected Folders & Indexing Through Directories

Dan Wendin

MacApp 2 programmers can usually ignore working directories; however, you need to use them when the user selects a folder and your program accesses the files in it without further user interaction. Selecting a folder gives you a real directory and MacApp 2 usually expects a working directory.

Working directories were introduced with the Hierarchical File System (HFS) in 1986 as a way to maintain compatibility with the original flat file system. They are returned by the standard file dialogs and passed to the MacApp 2 file methods that deal with opening files.

Most applications let MacApp 2 take care of this. And the file manager chapter in Inside Mac Volume IV covers working directories in gruesome detail, making it difficult to sort out what you need to know. Hence this article.

To set the stage, suppose your file-based application has an Export function to generate a text file for a 4D data base application. To make things easier on the 4D application, the user can export any number of files into a single export file with a fixed name. The user puts all the files to be processed into one folder before starting your application. In your application, the user selects a folder and you take care of everything from that point on.

I have implemented a set of file based objects similar to Tom Becker's approach in his April Frameworks article and which (hopefully) anticipate MacApp 3. This is reflected to some extent in the sample code on the FrameWorks Disk.

CHOOSING A FOLDER

I adapted the code in DTS's sample code SC.018.StdFile to work with MacApp 2. This puts up a slightly modified version of the selection dialog used by MPW's Set Directory command (Figure 1). This dialog is a real DLOG/DITL resource pair, not a MacApp dialog. Its definition must be copied into one of your myApp.r files and then created using Res.

Once you have it in a myApp.rsrc file, you can change it using ResEdit or AppMaker (the standard AppMaker version 1.1, not the MacApp version 1.2). ViewEdit cannot access these resources.

The Select Button completes the selection process. Double clicking on a folder (or clicking the Open button) opens the folder and displays the folders one level down. The Select Current Folder button keeps the user from having to go up one level to select the current folder.

The call to SFPGetFile that displays the dialog looks like this:

SFPGetFile(where, '', @FoldersOnly, numTypes, pTypeList^,
            @FolderHook, gFolderReply, kGetFoldersDlgId, nil);

FoldersOnly and FolderHook are filter functions. These functions, and any variables they need to access, must be global within their unit. They can't be methods, nor can they be local to the procedure containing SFPGetFile. Tech Note 265, "Pascal To C-PROCEDURE Parameters," explains why-it has to do with limitations in the toolbox with respect to nested procedures.

The FoldersOnly function simply tests the ioFlAttrib field of the parameter block passed to it and returns true if a folder. The parameter numTypes is -1 to tell StdFile to consider all types filtered by FoldersOnly. The pTypeList parameter is ignored-except that it must point to a valid memory location.

The FolderHook function does the real work. The tricky part is that there are only two states for the gFolderReply.good field-true or false-and there is no way to set it to true because the Open button doesn't exit. So FolderHook sets a global flag to true and then acts as if the Cancel button was hit. The Cancel button sets this flag to false. In either case, gFolderReply.good is false, so it is ignored.

FolderHook puts the directory and vRefnum in globals for return to the client. These are the real directory and the real vRefnum. The vRefnum is obtained from low memory location $214, which contains the negative of the current vRefnum. The directory hilighted in the list is in gFolderReply.fType. This is returned in the global if the user clicks the Select button. The current directory is in low memory location $398 and this is returned if the user clicks the Select Current Folder button.

Are there files in the folder? The function ThereAreFiles asks for the first file of the required type using the same function GetFileInFolder that is used to index through the files in the folder. (This is discussed in detail below.)

index := 1;
ThereAreFiles := Self.fFolderDoc.GetFileInFolder(fDirectory,
                                    index, anAppFile, kFileType);

GetFileInFolder returns true if a file is found, and the parameter anAppFile identifies the file. It's ignored here, since we only care whether or not there is a file.

Does the output file already exist?

Because the same file name is used for all export files, I don't want to let the user to destroy an existing file, as the normal SFPPutFile would allow him to do. So, the code needs to check for that case and prevent him from going further. My ThisFileExistsInDir method does this using the toolbox call PBHGetFInfo to get the file's Finder info. The real vRefnum and directory ID are passed in the parameter block's ioVRefnum and ioDirID fields. If successful, then the file exists, and the method returns true:
with pBlock, theAppFile do {an HParamBlockRec}
begin
    ioNamePtr := @fName;
    ioFDirIndex := 0;
    ioVRefnum := vRefnum; {real vRefNum}
    ioDirID := theDirectory
end;
err := PBHGetFInfo(@pBlock, false);
ThisFileExistsInDir := err = noErr

OPENING THE OUTPUT FILE

Now it's time to worry about the distinction between real and working directories. The MacApp methods and utility functions that open files expect working directories as their vRefnum parameters. The first thing they do is convert to a real directory and vRefnum. In allocating and opening a file based object, fOutputFile, we switch to a working directory, open the new file and then switch back.
Self.SwitchToWorkDir(theAppFile, itsDirectory);
Self.OpenNewFile(theAppFile);
Self.RestoreVRefnum(theAppFile);

My SwitchToWorkDir method uses the toolbox call PBOpenWD to open a working directory. It passes the real vRefnum and directory ID, and the application's signature in the parameter block's ioVRefnum, ioWDDirID and ioWDProcID fields, respectively, and gets back the working directory ID in the ioVRefnum field.

with pBlock do {a WDPBRec}
begin
    ioNamePtr := nil;
    ioVRefNum := anAppFile.vRefnum; {the real vRefNum}
    ioWDDirID := theDirectory; {the real directory}
    {program signature}
    ioWDProcID := longint(kSignature); 
    {assign a working ID}
    err := PBOpenWD(@pBlock, false); 
    {switch vRefnum to Working Directory}
    anAppFile.vRefnum := ioVRefNum 
end {with}

This working directory is passed as the vRefnum to OpenNewFile. Because of this doubling up of the ioVRefnum field, the real vRefnum must be available for restoring after the file is opened. OpenNewFile is an adaptation of the MacApp 2 open new file method moved from TApplication.

There are perhaps 40 working directories available to all applications open under MultiFinder under System 6; there are fewer in System 7. There is only one working directory for each file regardless of which application is accessing the file.

Working directories that aren't in use (that is, have no active file buffers associated with them) are closed when the application that opened them quits or if an application explicitly closes them with no active file buffers associated. Therefore, there is the potential of stepping on another application if we explicitly close a working directory. However, I chose to do this rather than risk causing my application and others to run out of working directories. In reality, I have a number of extract files open and, as shown below, we have to do the same thing for the existing files we process.

My RestoreVRefnum method uses the toolbox call PBCloseWD to close the working directory, passing the working directory. It then restores the original vRefnum.

with pBlock do {a WDPBRec}
begin
    ioVRefNum := anAppFile.vRefnum; {the working directory}
    err := PBCloseWD(@pBlock, false); {release working ID}
end;

INDEXING THROUGH THE FILES

I use the GetFileInFolder method, mentioned above, to index through the file. The index is set to 1 before calling. The method returns the next file of the requested type and its index. Subsequent calls move the index on to the next file, returning false when the list is exhausted.
index := 1;
repeat
fileReturned := aFolderDoc.GetFileInFolder(fDirectory,
                                index, theAppFile, kFileType);
if fileReturned then
    begin
      {allocate an object for the file, which opens the file}
        New(anExtractDoc);
        FailNil(anExtractDoc);
        anExtractDoc.ICFExtractDoc(kFileType, kSignature,
                    theAppFile, itsDir, kFileExists, cancelled);

            {process this file if no problem opening}
        if not cancelled then
            anExtractDoc.ProcessFile(Self.fOutputFile);

        FreeIfObject(anExtractDoc)
    end
until not fileReturned;

My GetFileInFolder method first uses the toolbox call PBGetCatInfo to determine if there is an item for the current index and, if so, whether it is a directory or a file. It passes the real vRefnum (from $214), directory and index in the parameter block's ioVRefnum, ioDrDirID and ioFDirIndex fields, respectively. If there is an item, it gets back a pointer to the name and file attributes in the ioNamePtr and ioFlAttrib fields. It returns to the caller with false if there are no more items in the list. It moves on to the next item if ioFlAttrib indicates a directory, not a file.

with block do {a CInfoPBRec}
begin
    ioNamePtr := @theName; {returns file or directory name}
    ioVRefNum := -(SFSaveDisk^); {current volume refnum}
    ioFDirIndex := index;
    ioDrDirID := theDirectory;
    err := PBGetCatInfo(@Block, false)
end;

The toolbox call PBHGetFInfo gets the file type, passing the same fields (the directory is passed in the ioDirID field). The file type in the finder info is returned in ioFlFndrInfo.fdType. If it matches, the real vRefnum and file name are returned to the caller. Otherwise, it moves on to the next item.

with fblock do {HParamBlockRec}
begin
ioNamePtr := @theName; {file name}
ioVRefNum := block.ioVRefNum; {real}
ioFDirIndex := index;
ioDirID := theDirectory;
ferr := PBHGetFInfo(@fBlock, false);

    {continue if not the type requested or an error}
stillLooking := (ferr <> NoErr) or
(ioFlFndrInfo.fdType <> theFileType)
end;

Because TDocument's ReadFromFile method wants a working directory, it is surrounded by calls to SwitchToWorkDir and RestoreVRefnum.

Don't forget to free the file object at the end of the repeat loop. Happy file indexing!

 
AAPL
$99.18
Apple Inc.
-1.57
MSFT
$45.90
Microsoft Corpora
-0.46
GOOG
$568.27
Google Inc.
-9.09

MacTech Search:
Community Search:

Software Updates via MacUpdate

Cocktail Family License (5 Macs) 7.6.1 -...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
Cocktail 8.0 Beta 2 - General maintenanc...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
QuickBooks 2015 16.0.0.1352 R1 - Financi...
QuickBooks 2015 helps you manage your business easily and efficiently. Organize your finances all in one place, track money going in and out of your business, and spot areas where you can save.... Read more
Mac DVDRipper Pro 5.0.1 - Copy, backup,...
Mac DVDRipper Pro is the DVD backup solution that lets you protect your DVDs from scratches, save your batteries by reading your movies from your hard disk, manage your collection with just a few... Read more
Apple OS X bash Update 1.0 - Fix for sec...
The OS X bash Update fixes a security flaw in the bash UNIX shell on OS X 10.9.5 (also on OS X 10.8 and 10.7 [see Related Links below]). OS X 10.9.5 or later Downloads for OS X 10.8 and OS X 10.7 in... Read more
SyncTwoFolders 2.0.5 - Syncs two user-sp...
SyncTwoFolders simply synchronizes two folders. It supports synchronization across mounted network drives and it is a possibility to run a simulation showing in a log what will be done. Please visit... Read more
FinderPop 2.5.7 - Classic Mac utility, n...
FinderPop is a Universal preference pane that extends OS X's contextual menus using a FinderPop Items folder much as the Apple Menu Items folder used to do for the Apple menu. It has other features... Read more
VueScan 9.4.45 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
LibreOffice 4.3.2.2 - Free Open Source o...
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
calibre 2.4 - Complete e-library managem...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital... Read more

Latest Forum Discussions

See All

Banner Saga (Games)
Banner Saga 1.0.17 Device: iOS Universal Category: Games Price: $9.99, Version: 1.0.17 (iTunes) Description: NOTE: The Banner Saga does NOT run on iPhone 4. iPhone 4S and more modern devices recommended. | Read more »
Beatbuddy HD (Games)
Beatbuddy HD 1.0.2 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.2 (iTunes) Description: **IMPORTANT** Beatbuddy runs only on iPhone 6, 6 Plus, 5, 5c, 5s, iPad 4, iPad Mini Retina and iPad Air. | Read more »
iKeywi - Customizable 5-Row Keyboard (U...
iKeywi - Customizable 5-Row Keyboard 1.0 Device: iOS Universal Category: Utilities Price: $.99, Version: 1.0 (iTunes) Description: Want to add an extra row to your iPhone/iPad? One of the most popular keyboard extension in iOS... | Read more »
Manage Your Cloud – Wunderlist Now Suppo...
Manage Your Cloud – Wunderlist Now Supports Dropbox Posted by Jessica Fisher on October 1st, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Nexticy Review
Nexticy Review By Jennifer Allen on October 1st, 2014 Our Rating: :: IDEAL FORM CREATIONiPad Only App - Designed for the iPad Nexticy allows you to make your own forms for research purposes or to organize your business better. It’s... | Read more »
Tiny Troopers: Alliance Marches onto the...
Tiny Troopers: Alliance Marches onto the App Store Tomorrow Posted by Jessica Fisher on October 1st, 2014 [ permalink ] Tiny Troopers: Alliance, by Kukouri, is a | Read more »
HeroCraft Introduces Unlimited Sequel to...
HeroCraft Introduces Unlimited Sequel to WW2: Sandbox. Strategy & Tactics Posted by Jessica Fisher on October 1st, 2014 [ permalink ] | Read more »
RGB Express Review
RGB Express Review By Jennifer Allen on October 1st, 2014 Our Rating: :: DELIGHTFUL PUZZLINGUniversal App - Designed for iPhone and iPad Guide trucks along their delivery routes in RGB Express, a testing but charming puzzle game... | Read more »
The Sagas of Fire*Wolf (Games)
The Sagas of Fire*Wolf 1.0 Device: iOS Universal Category: Games Price: $9.99, Version: 1.0 (iTunes) Description: | Read more »
BuggyFun Review
BuggyFun Review By Amy Solomon on October 1st, 2014 Our Rating: iPad Only App - Designed for the iPad BuggyFun allows children to create their own tracks for bugs to interact with for a unique open-ended experience.   | Read more »

Price Scanner via MacPrices.net

ASUS, Lenovo, and Amazon Slug It Out For Tabl...
According to market intelligence firm ABI Research, Apple and Samsung have led the touchscreen tablet market by a substantial margin since Apple energized the category back in 2010. However, ABI says... Read more
Amazon offers 13-inch MacBook Air for $899, $...
Amazon.com has the 13″ 1.4GHz 128GB MacBook Air on sale for $100 off MSRP including free shipping: - 13″ 1.4GHz 128GB MacBook Air: $899.99 Read more
Apple resting On Its iPhone Laurels? – The ‘B...
Apple calls its new iPhone 6 and 6 Plus “The Biggest Advancements in iPhone History,” but does reality live up to the hype? “Seldom have so many waited so breathlessly for so little,” tweeted veteran... Read more
Roundup of Apple Mac and iPad Education disco...
Purchase a new Mac or iPad at The Apple Store for Education and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free,... Read more
Apple Boycotts German Magazine Computer Bild...
Apple has revoked its PR accreditation of Germany’s Computer Bild, Europe’s best-selling PC magazine, in reaction to Bild’s posting of a “#Bentgate” YouTube video. Axel Telzerow, editor in chief of... Read more
iPhone 6 & iPhone 6 Plus Available in Chi...
Apple has announced that iPhone 6 and iPhone 6 Plus will be available in China beginning Friday, October 17 from the Apple Online Store (http://www.apple.com), Apple’s retail stores, and an expansive... Read more
MacBook Airs on sale for $100 off MSRP, start...
Best Buy has the new 2014 MacBook Airs on sale for $100 off MSRP on their online store. Choose free home shipping or free local store pickup (if available). Prices valid for online orders only, in-... Read more
Apple Releases OS X Mavericks bash Update 1.0...
Apple has released a patch update for OS X Mavericks users to address the recently-detected “Shellshock” security bug in BSD UNIX’s bash shell. Apple says only a few Mac users who had manually... Read more
Pivotal Payments Ready for Apple Pay – FlexPo...
Pivotal Payments, a provider of merchant services and global payment processing solutions, has announced its proprietary FlexPoint platform will support credit and debit transactions through Apple’s... Read more
iStabilizer Announces Tabarm — First Friction...
iStabilizer, a specialist in universal lightweight compact tripods, steady cams, dollies, mounts, and remotes for smartphones, tablets, and cameras, announced today the iStabilizer tabArm, the first... 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...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.