TweetFollow Us on Twitter

File Dialog
Volume Number:3
Issue Number:2
Column Tag:ToolBox Tricks

Not So Standard File Dialogs

By Paul Snively, Contributing Editor, Icom Simulations, Inc.

Last month I discussed how INIT resources could be debugged using TMON, as I did in developing my Set/Boot Paths desk accessory, used in TML Pascal 2.0. Set Paths allows the user to specify what path to use via what I prefer to call the Not-So-Standard File dialog. It's Not-So-Standard because it doesn't display file names at all, only folder names. That's not so weird (nor is it particularly difficult to code), but the "Open" button has become "Select" and, the tricky part, double-clicking on a folder name opens it exactly the way you'd expect, whereas highlighting a folder name and clicking on "Select" returns you to your program with pertinent information about the selection.

Experienced Standard File hackers may knot their brows at this (as I did when I was asked to do it that way) because they know that the Standard File internally coerces double-clicks on names to be a single click followed by a click on the "Open" button, so that the Standard File hook can filter double-clicks. The trick, then, is being able to use a user-written Standard File hook to distinguish between a double-clicked name and a selected name followed by a "Select" click.

Note that my solution is a kludge by just about any definition of the word, and would be universally spurned (even by me) were it not for one simple, overriding fact: it does NOT rely on internal knowledge of Standard File's workings AT ALL, and it was simple and obvious enough to have gone from concept to implementation in less than twelve hours (an important consideration for me; I modemed the resultant files to TML Systems Sunday evening; TML Pascal 2.0 started shipping the next day)!

To start off on an embarrassing note, in the process of writing Set Paths I discovered a bug in my McAssembly Pascal interface macros. Those were published in MacTutor Vol. 2, No. 3, in March 1986, which says two things to me: I need to be more careful in my testing of things before I publish them, and no one has done anything significant with those macros, otherwise they would have encountered the bug and, hopefully, written a letter to the editor about it! I'm profoundly disappointed

Anyway, the bug is in the "Exit" macro. There's a line which is responsible for adjusting the stack back to normal by dropping input parameters. It says:

add.l    #.fsize-.parms,sp

This is a definite boo-boo, because it totally neglects the space that we allocated for the stacked A6 register and the return address of the function. The line SHOULD read:

add.l   #.fsize-.parms-8,sp.

Boy, do I feel appropriately chastized!

Having cleared that up, I can talk safely about using those macros to implement the Not-So-Standard File dialog.

First we need to come up with a way to display NO files at all. The first time I tackled this, ol' Paul thought he'd be tricky and just set the numTypes parameter to _SFGetFile to zero, thereby forcing _SFGetFile to ignore all files, right? Wrong! Even though I had a typeList consisting of all zeros and a numTypes of zero, _SFGetFile insisted on displaying ALL files on the volume, and it took forever to do it, too!

I decided to do something about the INCREDIBLY slow response I was getting from the above scheme. Besides, it didn't work! I changed numTypes to one and used a fileType of '????' to get as few files as possible (theoretically zero). Since every so often you will indeed see a file of type '????' it behooved me to ensure that they didn't show up in the file list. To do that I had to use that fileFilter that I had tried to avoid.

The fileFilter proc is, like most such things for the Macintosh, designed with the expectation that it will be written conforming to Pascal-style parameter passing conventions. It is (in Pascal terms, anyway) a function, not a procedure, since it returns a value. It takes one parameter, a pointer to a low-level parameter block a lá the file system, and returns a boolean. It seems a little backwards: the boolean should be TRUE if the file is NOT to be displayed, and FALSE if the file IS to be displayed. So, since we want to display NO files, we should simply set the boolean to TRUE and we are done! In Pascal this would look something like this:

FUNCTION MyFileFilter(PB : ParamBlockRec;) : BOOLEAN;

BEGIN {MyFileFilter} 
 MyFileFilter := TRUE;
END; {MyFileFilter}

In McAssembly, with my Pascal macros, it's almost as easy: (See MacTutor Vol. 2, No. 3 March 1986 for the definition of these Macros.)

 MyFileFilter  EQU *
 ;
 SFBegin
 WordResult MyFilterResult
 Long   MyParamBlock
 SFEnd
 ;
 Enter
 move.w #-1,MyFilterResult
 Exit

The combination of the file type of '????' and the above fileFilter works like a charm; by golly, no files show up!

SFHook

The remaining magic is in an underdiscussed piece of code called a SFHook. Apple describes the SFHook as something that can be used to make a non-standard get or put file (which I almost do) or to make the normal one behave in non-standard ways (which is EXACTLY what I do)!

The SFHook is also a Pascal-like entity; it takes two parameters; the item number (an integer), and the DialogPtr to the Standard File dialog. It returns an integer (an item number also, although it may or may not be the same as the one that was passed to it)!

The SFHook is called constantly throughout the operation of the Standard File dialog; it's called before the dialog is drawn, it's called when there are significant events, and it's even called when there are NO significant events!

The key to understanding the Standard File dialog as it applies to writing a SFHook is the item number. The item number is ordinarily simply the item number of whatever the user clicked on in the dialog box. In addition to that there have always been a few "phony" items numbers, such as item # 100 (which is what was passed when nothing interesting was going on) or keystrokes (item # 1000 plus the ASCII value of the key). Another useful value is -1, which is the value passed before the dialog is displayed. By trapping on this value we can do neat things like changing the title of the "Open" button to "Select." You'll see an example of that a bit later.

The introduction of HFS added a whole new wrinkle to the issue of the Standard File dialog. It had to be expanded in a way that retained the power and flexibility of the original design, yet also remain upwardly compatible. WDRefNum's and a few new phony item numbers fit the bill rather nicely.

As all users of the Standard File dialog are aware of at one level or another, "Opening" a folder doesn't return you to the application, it simply makes that folder the current directory and shows you the files in it, etc. You must open a FILE to get back from _SFGetFile.

Internally what happens is that opening a folder passes a phony item # 103 to the SFHook, as opposed to a file open, which passes item # 1 (the item # of the "Open" button). So we could catch the 103, coerce it to a 1, and pass it back. The problem there, of course, is the one mentioned before: double-clicks on filenames and filename select/"Open" click sequences are equivalent by the time you get to the SFHook! The result is that double-clicking on a foldername returns from _SFGetFile just as surely as selecting one and clicking "Open" does!

Argh!!!

Ok, enough beating around the bush. Obviously the solution to the problem is to find out which item we clicked on, the file list or the "Select" button. I decided that the Mac was fast enough that I could determine within the SFHook where the mouse was, check to see if it was over the file list and, if it was not, coerce the 103 to a 1. Fortunately, one of the things passed to the SFHook is the DialogPtr, making calls to _GetDItem possible. Among other things, _GetDItem returns the viewRect of the item - just what the doctor ordered! _GetMouse gives us our mouse location in local coordinates (another stroke of luck) and _PtInRect answers the burning question: are we pointing to this item or aren't we?

Pulling it all together into a nice, not-so-neat package gives us the following:

UseSF  move.w  #100,-(sp) Top = 100
 move.w #100,-(sp) Left = 100
 pea  PromptString Use promptstring
 pea  myFileFilter Use brief fileFilter
 move.w #1,-(sp) No. of filetypes
 pea  MyListPoint to my list
 pea  myDlgHook  Point to our dlgHook
 pea  myReplyRec Point to reply rec
 _SFGetFile Use std file dialog
 
myDlgHook
;
 sfbeginDeclare stack frame
 wordresult myDlgResult Function result
 word mySFItem Which item was hit?
 long theDialog  SFGetFile dialog ptr
 sfend  That's all!
;
 enter  Set up stack frame
 move.w mySFItem,d0Get the item#
 cmp.w  #-1,d0 Is this first time?
 bne  NotFirst Go if not
 sub.l  #14,sp Room for VAR params
 move.l theDialog,-(sp) Stack DialogPtr
 move.w #getOpen,-(sp)  Stack item # of "Open"
 pea  18(sp)VAR itemType
 pea  18(sp)VAR itemHandle
 pea  14(sp)VAR dispRect
 _GetDItemTell me about button
 movea.l8(sp),a0 Get handle
 add.l  #14,sp Drop data structure
 move.l a0,-(sp) Stack item handle
 pea  myTitle  Pass title address
 _SetCTitle Make title = STR
 moveq  #-1,d0 Make sure we're here
NotFirstequ *
 cmp.w  #103,d0  Was it "Select?"
 bne.s  NotSelectGo if not
;***********************************************************
;***  This is where we will do all kinds of nifty magic ***
;**********************************************************
 sub.l  #14,sp Room for VAR params
 move.l theDialog,-(sp) Stack DialogPtr
 move.w #7,-(sp) Stack File List item#
 pea  18(sp)VAR itemType
 pea  18(sp)VAR itemHandle
 pea  14(sp)VAR dispRect
 _GetDItemTell me about File List
 clr.l  -(sp)  Room for pt
 pea  (sp)Point to the point
 _GetMouseHere, mousie, mousie...
 pea  4(sp) Point to the rect
 _PtInRectAre we in File List?
 move.w #103,d0  Just to make sure
 move.b (sp)+,d1 Get answer
 add.l  #12,sp Drop remaining data
 bne.s  NotSelectIf in File List, leave
 move.w #1,d0  Treat like file open
NotSelect equ  *
 move.w d0,myDlgResult  Store function result
 exit   Exit the function
;
myFileFilterequ  *
 loc  New locals here; needed for McAssembly
;
 sfbeginStack Frame Begin
 wordresult myFilterResultA boolean
 long parmBlkPtr A pointer
 sfend  Stack Frame End
;
 enter  Set up stack frame
 move.w #-1,myFilterResultTRUE;
 exit   Clean up and leave
;
PromptStringequ  *
 text # "Highlight a folder and click /"Select/""
 align
myTitle equ *
 text # "Select" title for "Open" button
 align
myList  equ *
 text "????"Any old file type will do
 dcb.b  12,0Remaining are nulls

Now that I've given the code that does the trick, I should probably say a few words about how the replyRec looks when you've opened a folder instead of a file.

First of all, you can forget about the fName field. It won't be valid. Instead, vRefNum will contain the vRefNum of the folder, just like it does for a file, and - get this - fType will return the DirID of the folder ("Sorry about the type conflict," says Apple in the software supplement...obviously talking to Pascal programmers). Of course, the vRefNum and DirID are sufficient for all HFS OSTraps that deal with folders or files within a specific folder. Another thing that you can do if you want or need to is convert the vRefNum and DirID to a pathname extending from the root to the folder (or more precisely, from the folder to the root). One implementation of that algorithm appeared in MacTutor's special HFS issue (January '86). It was written in C by Mike Schuster. Translating it to the language of the reader's choice is an exercise left to the reader (the assembler version is actually rather simple).

That just about covers it. Feel free to use the Not-So-Standard File dialog anytime you have a reason to want to select a folder instead of a file!

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

PDFKey Pro 4.3 - Edit and print password...
PDFKey Pro can unlock PDF documents protected for printing and copying when you've forgotten your password. It can now also protect your PDF files with a password to prevent unauthorized access and/... Read more
Kodi 15.0.beta1 - Powerful media center...
Kodi (was XBMC) is an award-winning free and open-source (GPL) software media player and entertainment hub that can be installed on Linux, OS X, Windows, iOS, and Android, featuring a 10-foot user... Read more
DiskCatalogMaker 6.4.12 - Catalog your d...
DiskCatalogMaker is a simple disk management tool which catalogs disks. Simple, light-weight, and fast. Finder-like intuitive look and feel. Super-fast search algorithm. Can compress catalog data... Read more
Macs Fan Control 1.3.0.0 - Monitor and c...
Macs Fan Control allows you to monitor and control almost any aspect of your computer's fans, with support for controlling fan speed, temperature sensors pane, menu-bar icon, and autostart with... Read more
Lyn 1.5.11 - Lightweight image browser a...
Lyn is a lightweight and fast image browser and viewer designed for photographers, graphic artists and Web designers. Featuring an extremely versatile and aesthetically pleasing interface, it... Read more
NeoOffice 2014.11 - Mac-tailored, OpenOf...
NeoOffice is a complete office suite for OS X. With NeoOffice, users can view, edit, and save OpenOffice documents, PDF files, and most Microsoft Word, Excel, and PowerPoint documents. NeoOffice 3.x... Read more
LaunchBar 6.4 - Powerful file/URL/email...
LaunchBar is an award-winning productivity utility that offers an amazingly intuitive and efficient way to search and access any kind of information stored on your computer or on the Web. It provides... Read more
Remotix 3.1.4 - Access all your computer...
Remotix is a fast and powerful application to easily access multiple Macs (and PCs) from your own Mac. Features Complete Apple Screen Sharing support - including Mac OS X login, clipboard... Read more
DesktopLyrics 2.6.6 - Displays current i...
DesktopLyrics is an application that displays the lyrics of the song currently playing in "iTunes" right on your desktop. The lyrics for the song have to be set in iTunes; DesktopLyrics does nothing... Read more
VOX 2.5.1 - Music player that supports m...
VOX is a beautiful music player that supports many filetypes. The beauty is in its simplicity, yet behind the minimal exterior lies a powerful music player with a ton of features and support for all... Read more

This Week at 148Apps: May 18-22, 2015
May Days at 148Apps How do you know what apps are worth your time and money? Just look to the review team at 148Apps. We sort through the chaos and find the apps you're looking for. The ones we love become Editor’s Choice, standing out above the... | Read more »
Biz Builder Delux (Games)
Biz Builder Delux 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: Ah, there's nothing like the rhythmic bustle of a burgeoning business burg... especially when you're the one building it... | Read more »
Auroch Digital is Bringing Back Games Wo...
| Read more »
Blades of Brim is a New Endless Runner f...
SYBO Games, the minds behind the ever-popular Subway Surfers, have announced their latest project: Blades of Brim. [Read more] | Read more »
Carbo - Handwriting in the Digital Age...
Carbo - Handwriting in the Digital Age 1.0 Device: iOS Universal Category: Productivity Price: $3.99, Version: 1.0 (iTunes) Description: | Read more »
Draggy Dead (Games)
Draggy Dead 1.1 Device: iOS Universal Category: Games Price: $.99, Version: 1.1 (iTunes) Description: Ditch your dead end job and take up a rewarding career in Grave Robbing today!Guide the recently deceased to a fun filled life of... | Read more »
Bad Dinos (Games)
Bad Dinos 1.0.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.0 (iTunes) Description: | Read more »
The Apple Watch isn't Great as a Fi...
| Read more »
Show the World What You See With Stre.am...
Live broadcasting is getting popular on mobile devices, which is why you can now get Stre.am, by Infinite Takes. [Read more] | Read more »
PhotoTime's 2.1 Update Adds Apple W...
The latest PhotoTime update is adding even more functionality to the handy photo organizing app. Yep, including Apple Watch support. [Read more] | Read more »

Price Scanner via MacPrices.net

12-inch MacBook stock status for Monday, May...
The new 12″ Retina MacBooks are still on backorder at The Apple Store with a 3-5 week waiting period. However, a few models are in stock today at Apple resellers. Stock is limited, so act now if you’... Read more
New 27-inch 3.3GHz 5K iMac in stock with free...
Adorama has the new 27″ 3.3GHz 5K iMac in stock today for $1999 including free shipping plus NY & NJ sales tax only. Adorama will include a free copy of Apple’s 3-year AppleCare Protection Plan. Read more
Memorial Day Weekend Sale: New 27-inch 3.3GHz...
Best Buy has the new 27″ 3.3GHz 5K iMac on sale for $1899.99 this weekend. Choose free shipping or free local store pickup (if available). Sale price for online orders only, in-store prices may vary... Read more
OtterBox Maximizes Portability, Productivity...
From the kitchen recipe book to the boarsroom presentation, the OtterBox Agility Tablet System turns tablets into one of the most versatile pieces of handheld technology available. Available now, the... Read more
Launch of New Car App Gallery and Open Develo...
Automatic, a company on a mission to bring the power of the Internet into every car, has announced the launch of the Automatic App Gallery, an app store for nearly every car or truck on the road... Read more
Memorial Day Weekend Sale: 13-inch 1.6GHz Mac...
Best Buy has the new 13″ 1.6GHz/128GB MacBook Air on sale for $849 on their online store this weekend. Choose free shipping or free local store pickup (if available). Sale price for online orders... Read more
Memorial Day Weekend Sale: 27-inch 3.5GHz 5K...
Best Buy has the 27″ 3.5GHz 5K iMac on sale for $2099.99 this weekend. Choose free shipping or free local store pickup (if available). Sale price for online orders only, in-store prices may vary.... Read more
Sale! 16GB iPad mini 3 for $349, save $50
B&H Photo has the 16GB iPad mini 3 WiFi on sale for $349 including free shipping plus NY sales tax only. Their price is $50 off MSRP, and it’s the lowest price available for this model. Read more
Price drop on 2014 15-inch Retina MacBook Pro...
B&H Photo has dropped prices on 2014 15″ Retina MacBook Pros by $200. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $1799.99 save $200 - 15″ 2.5GHz... Read more
With a Mission to Make Mobile Free, Scratch W...
Scratch Wireless, claiming to be the world’s first truly free mobile service, has announced the availability of a new Scratch-enabled Android smartphone, the Coolpad Arise. The smartphone is equipped... Read more

Jobs Board

*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
*Apple* TV Live Streaming Frameworks Test En...
**Job Summary** Work and contribute towards the engineering of Apple 's state-of-the-art products involving video, audio, and graphics in Interactive Media Group (IMG) at 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
Partner Marketing Manager, Merchant- *Apple*...
**Job Summary** The Apple Pay partner marketing team is looking for a marketing manager to develop and drive US marketing programs with our merchant partners. The right Read more
Technical Project Manager - *Apple* Pay - A...
**Job Summary** Apple Pay is seeking an experienced technical PM to…manage the on boarding of new merchants for the Apple Pay platform in the US Within this role you Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.