TweetFollow Us on Twitter

Easy FKEY
Volume Number:8
Issue Number:2
Column Tag:Pascal Workshop

Related Info: File Manager Event Manager

FKEYs in THINK Pascal, Easy

Have you ever had to restart because a file was left open? No more! Read on.

By Roy Lovejoy, Sunnyvale, California

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.

About the author

Roy Lovejoy is a Software Engineer at Calera Recognition Systems. He was previously working at Claris Corporation as one of the MacWrite II engineers. This is his first article for MacTutor. What do you think?

A Bit of History

When the Macintosh arrived on the scene in February of 1984, the world knew it was unique; its profile, screen, and keyboard were all different from the then-standard IBM PC. One of the attributes that IBM-ers scoffed at was the lack of "Function keys". You know function keys, those funky little buttons that do an infinitely many different things (depending on which program you are running). Well, we have news for the scoffers. The Macintosh has had function keys, or FKEY’s as they are called, since its inception.

The FKEY’s that were included were ones to eject the internal and external floppy disk, take a snapshot of the screen and save it to a MacPaint file, and print the screen, or the front window. These FKEY’s were assigned numbers 1 , 2, 3, and 4 respectively and were triggered by the Command key followed by the associated digit. Since the introduction of different size and depth screens, and printers, they of course had to be modified. Many people have written other useful FKEY's, and some have become very well known (i.e., switch-a-roo).

FKEY's are a pretty safe bet. Since they are trapped during a GetNextEvent or WaitNextEvent, they are available in a large percentage of applications. Since Desk Accessories are going the way of the brontosaurus, or so they say, FKEY’s are (hopefully) a safe utility feature in the future.

General

Now these function keys are in no way difficult to code. They are just simply different to code. I have found that if I need a utility, an FKEY is always my first choice, then comes a Desk Accessory, then an Application. (You don’t have all of the DRVR problems that are inherent in a desk accessory.) Basically an FKEY is a procedure that has no true globals (true globals are ones that are referenced off of the 68000 register A5) and is compiled to an 'FKEY' resource. There are many safe, and many sneaky ways to have a 'global' area, but that will be good subject matter for a future article.

An FKEY can be completely Modal - it might simply bring up a Dialog and let you set/reset a value, or it can have a robust user interface, complete with menus and windows. This article will describe the former.

In THINK Pascal, an FKEY is simply a unit that is compiled into a resource, of type FKEY. See figure for Project Setup. The unit must have the entry procedure be called ‘main’ and have no parameters. There must not be a ‘program’. See Figure 1.

Figure 1: Set Project Dialog (set for FKEY #5)

Why did I write this?

As an applications programmer I have many times (read > 300) written file I/O routines that save and retrieve program’s data structures. Naturally, in the course of human events, errors happen, sunspots appear, neutrinos expire, all after you open a data file, but before you get a chance to close it properly. This problem leads to a file, on your storage device, that is marked busy. This file can not be closed by your program (your variables have since committed electronic suicide, and your FileRefNum has gone with them), and you can not throw the file out, (because the busy bit is set). So, what do you do? Well, the busy bit is reset when the volume gets dismounted. That is acceptable for a floppy disk, but if it is your currently-booted hard disk, that poses a problem. What I wanted to do was an FSClose on the file, regardless of how it got opened. I was very frustrated, logged countless hours on networks looking for a utility to ease my woes. Finally I said, forget it, I’ll do it myself. Here it is.

What does it do?

Basically, when you (or any application) do an FSOpen or equivalent, memory is allocated for the file’s information. This FKEY simply tries to open the file; if the file is already open, it makes a parameter block call to get the file reference number, then uses that to close the file. If the file was not open originally, it is now because of the FSOpen, and so the FKEY goes ahead and closes it. A diagnostic dialog makes everything friendly.

A Bit of Style

The final resting place of an FKEY is either the System File or an exterior resource opened by a Suitcase-like program. This does not mean you can’t debug it elegantly. Oh, sure. “It’s a code resource. Those are hard to debug!!” I have some Arizona beach front property for you, too. What I do is have two Think projects. One has the standard Runtime.Lib and an extra file that is just a program stub that calls ‘Main’. I can then go on and debug in the glorious THINK environment. The other project has the DRVRruntime.lib and no ‘program’ file. This one has debugging turned off and the project type set to code resource. See Figures 2 and 3.

Figure 2: Project Set Up for debugging

Figure 3: Project Set Up for compiling

Listing

{======================}
unit FKEY;
{======================}
interface
{======================}
 procedure Main;
{======================}
implementation
{======================}
 procedure Main;
 var
 dlgOrigin: Point; {Top-left corner of dialog box}
 theReply: SFReply;{Data returned by SFGet dialog}
 theFile: INTEGER; {Reference number of file}
 resultCode: OSErr;{I/O error code}
 TypeList: SFTypeList;  {Type List to search for }
 Block: ParamBlockRec;  {Used to get file ref number}
 WIND: WindowPtr;{Display Window }
 bounds: Rect; {window rectangle Rectangle }
 OldPort: GrafPtr; {Graf Port set upon entry}
 dummy: LONGINT; {parameter of Delay}
{======================}
{ CenterDraw}
{ Input: String to Draw , line number to draw on.}
{ (String is centered horizontally on the window.)}
{======================}
 procedure CenterDraw (s: Str255; y: INTEGER);
 var
 x: INTEGER;
 begin
 with WIND^.portRect do
 begin
 x := (right + left) div 2 - StringWidth(s) div 2;
 MoveTo(x, y * 16);
 end;
 DrawString(s);
 end;
{======================}
 begin
 GetPort(OldPort);
 SetRect(bounds, 85, 40, 420, 100);
 WIND := NewWindow(nil, bounds, '', TRUE, dBoxProc, pointer(-1), FALSE, 
0);
 SetPort(WIND);
 TextFace([underline]);
 CenterDraw('Close File FKEY', 1);
 TextFace([]);
 CenterDraw('Select the file you wish to close.', 2);

 SetPt(dlgOrigin, 85, 120);         {Set up dialog origin}
 SFGetFile(dlgOrigin, '', nil, -1, TypeList, nil, TheReply);

 with TheReply do
 if good then
 begin
{Try to open file}
 resultCode := FSOpen(fname, vRefNum, theFile);
{if it was already open, get the file ref number}
 if resultCode = opWrErr then
 with Block do
 begin
 ioNamePtr := @fName;
 ioVRefNum := vRefNum;
 ioFDirIndex := -1;
 resultCode := PBGetFInfo(@Block, false);  {Get Finder info}
 theFile := ioFRefNum;
 CenterDraw(Concat('“', fName, '” is now closed.'), 3);
 end
 else
 CenterDraw(Concat('“', fName, '” was not open.'), 3);
{Do the actual closing... regardless if it was open before the FKEY or 
not}
 ResultCode := fsClose(theFile);
 end;
 Delay(45, dummy);{Wait a while 3/4 of second}

 DisposeWindow(WIND); {Close up}
 SetPort(OldPort);
 end;
{======================}
end.
{======================}

program Test;
 uses
 FKEY;
begin
 Main;
end.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Logic Pro X 10.1.1 - Music creation and...
Apple Logic Pro X is the most advanced version of Logic ever. Sophisticated new tools for professional songwriting, editing, and mixing are built around a modern interface that's designed to get... Read more
VLC Media Player 2.2.0 - Popular multime...
VLC Media Player is a highly portable multimedia player for various audio and video formats (MPEG-1, MPEG-2, MPEG-4, DivX, MP3, OGG, ...) as well as DVDs, VCDs, and various streaming protocols. It... Read more
Sound Studio 4.7.8 - Robust audio record...
Sound Studio lets you easily record and professionally edit audio on your Mac. Easily rip vinyls and digitize cassette tapes, or record lectures and voice memos. Prepare for live shows with live... Read more
LibreOffice 4.4.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
Freeway Pro 7.0.3 - Drag-and-drop Web de...
Freeway Pro lets you build websites with speed and precision... without writing a line of code! With its user-oriented drag-and-drop interface, Freeway Pro helps you piece together the website of... Read more
Cloud 3.3.0 - File sharing from your men...
Cloud is simple file sharing for the Mac. Drag a file from your Mac to the CloudApp icon in the menubar and we take care of the rest. A link to the file will automatically be copied to your clipboard... Read more
Cyberduck 4.6.5 - FTP and SFTP browser....
Cyberduck is a robust FTP/FTP-TLS/SFTP browser for the Mac whose lack of visual clutter and cleverly intuitive features make it easy to use. Support for external editors and system technologies such... Read more
Firefox 36.0 - Fast, safe Web browser. (...
Firefox for Mac offers a fast, safe Web browsing experience. Browse quickly, securely, and effortlessly. With its industry-leading features, Firefox is the choice of Web development professionals and... Read more
Thunderbird 31.5.0 - Email client from M...
As of July 2012, Thunderbird has transitioned to a new governance model, with new features being developed by the broader free software and open source community, and security fixes and improvements... Read more
VOX 2.4 - Music player that supports man...
VoxIt just sounds better! The beauty is in its simplicity, yet behind the minimal exterior lies a powerful music player with a ton of features & support for all audio formats you should ever need... Read more

Get The Whole Story – Lone Wolf Complete...
Get The Whole Story – Lone Wolf Complete is Now Available and On Sale Posted by Jessica Fisher on February 27th, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Who Wore it Best? The Counting Dead vs....
Like it or not, the “clicker” genre, popularized by cute distractions like Candy Box and Cookie Clicker, seems like it’s here to stay. So Who Wore it Best? takes a look at two recent examples: The Counting Dead and AdVenture Capitalist. | Read more »
Card Crawl, the Mini Deck Building Game,...
Card Crawl, the Mini Deck Building Game, is Coming Soon Posted by Jessica Fisher on February 27th, 2015 [ permalink ] Tinytouchtales and Mexer have announced their new game, | Read more »
Witness an all new puzzle mechanic in Bl...
Well, BlastBall MAX is not one of those games and is bucking trends such as timers, elements of randomness, and tacked-on mechanics in favor of pure puzzle gameplay. When you first boot up the game you’ll see a grid made up of squares that are each... | Read more »
This Princess Has a Dragon and She isn’t...
This Princess Has a Dragon and She isn’t Afraid to Useit. | Read more »
Mecha Showdown Review
Mecha Showdown Review By Lee Hamlet on February 27th, 2015 Our Rating: :: IN A SPINUniversal App - Designed for iPhone and iPad Mecha Showdown replaces traditional buttons with a slot machine mechanic in this robot fighting game,... | Read more »
Reliance Games and Dreamworks Unveil Rea...
Reliance Games and Dreamworks Unveil Real Steel Champions Posted by Ellis Spice on February 27th, 2015 [ permalink ] Reliance Games and Dreamworks have announced that a third game in | Read more »
Sum Idea Review
Sum Idea Review By Jennifer Allen on February 27th, 2015 Our Rating: :: TAXING NUMBERSUniversal App - Designed for iPhone and iPad Sum Idea is a fairly charming but taxing puzzle game.   | Read more »
A New Badland Update Brings Daydream Lev...
A New Badland Update Brings Daydream Levels to Co-Op Posted by Ellis Spice on February 27th, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Slashing Demons Review
Slashing Demons Review By Lee Hamlet on February 27th, 2015 Our Rating: :: IT'S A LONG WAY TO THE TOPUniversal App - Designed for iPhone and iPad Slashing Demons lacks the depth or scope to take it beyond the point of being just... | Read more »

Price Scanner via MacPrices.net

Apple CEO Tim Cook to Deliver 2015 George Was...
Apple CEO Tim Cook will deliver the George Washington University’s Commencement address to GWU grads on May 17, at which time he will also be awarded an honorary doctorate of public service from the... Read more
Apple restocks refurbished Mac minis for up t...
The Apple Store has restocked Apple Certified Refurbished 2014 Mac minis, with models available starting at $419. Apple’s one-year warranty is included with each mini, and shipping is free: - 1.4GHz... Read more
Save up to $50 on iPad Air 2s, NY tax only, f...
 B&H Photo has iPad Air 2s on sale for $50 off MSRP including free shipping plus NY sales tax only: - 16GB iPad Air 2 WiFi: $469.99 $30 off - 64GB iPad Air 2 WiFi: $549 $50 off - 128GB iPad Air 2... Read more
16GB iPad Air 2 on sale for $447, save $52
Walmart has the 16GB iPad Air 2 WiFi on sale for $446.99 on their online store for a limited time. Choose free shipping or free local store pickup (if available). Sale price for online orders only,... Read more
iMacs on sale for up to $205 off MSRP
B&H Photo has 21″ and 27″ iMacs on sale for up to $205 off MSRP including free shipping plus NY sales tax only: - 21″ 1.4GHz iMac: $1029 $70 off - 21″ 2.7GHz iMac: $1199 $100 off - 21″ 2.9GHz... Read more
Apple Takes 89 Percent Share of Global Smartp...
According to the latest research from Strategy Analytics, global smartphone operating profit reached US$21 billion in Q4 2014. The Android operating system captured a record-low 11 percent global... Read more
New Travel Health App “My Travel Health” iOS...
Rochester, Minnesota based Travel Health and Wellness LLC has announced that its new iOS app help safeguard the user’s health when traveling abroad — “My Travel Health” is now available on the Apple... Read more
Sale! MacBook Airs for up to $115 off MSRP
B&H Photo has MacBook Airs on sale for up to $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 11″ 128GB MacBook Air: $799 100 off MSRP - 11″ 256GB MacBook Air: $999 $100... Read more
15-inch 2.0GHz Retina MacBook Pro (refurbishe...
The Apple Store has Apple Certified Refurbished previous-generation 15″ 2.0GHz Retina MacBook Pros available for $1489 including free shipping plus Apple’s standard one-year warranty. Their price is... Read more
Wither The iPad mini? End Of The Road Imminen...
AppleDailyReport’s Dennis Sellers predicts that the iPad mini is going to be left to wither on the vine, as it were, and then just allowed to fade away — a casualty of the IPhone 6 Plus and other... Read more

Jobs Board

Sr. Technical Services Consultant, *Apple*...
**Job Summary** Apple Professional Services (APS) has an opening for a senior technical position that contributes to Apple 's efforts for strategic and transactional Read more
Event Director, *Apple* Retail Marketing -...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global engagement strategy and team. Delivering an overarching brand Read more
*Apple* Pay - Site Reliability Engineer - Ap...
**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
*Apple* Solutions Consultant - Retail Sales...
**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
*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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.