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.

 
AAPL
$97.99
Apple Inc.
-0.39
MSFT
$43.50
Microsoft Corpora
-0.39
GOOG
$585.57
Google Inc.
-0.04

MacTech Search:
Community Search:

Software Updates via MacUpdate

Mellel 3.3.6 - Powerful word processor w...
Mellel is the leading word processor for OS X and has been widely considered the industry standard since its inception. Mellel focuses on writers and scholars for technical writing and multilingual... Read more
LibreOffice 4.3.0.4 - 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
Freeway Pro 7.0 - Drag-and-drop Web desi...
Freeway Pro lets you build websites with speed and precision... without writing a line of code! With it's user-oriented drag-and-drop interface, Freeway Pro helps you piece together the website of... Read more
Drive Genius 3.2.4 - Powerful system uti...
Drive Genius is an OS X utility designed to provide unsurpassed storage management. Featuring an easy-to-use interface, Drive Genius is packed with powerful tools such as a drive optimizer, a... Read more
Vitamin-R 2.15 - Personal productivity t...
Vitamin-R creates the optimal conditions for your brain to work at its best by structuring your work into short bursts of distraction-free, highly focused activity alternating with opportunities for... Read more
Toast Titanium 12.0 - The ultimate media...
Toast Titanium goes way beyond the very basic burning in the Mac OS and iLife software, and sets the standard for burning CDs, DVDs, and now Blu-ray discs on the Mac. Create superior sounding audio... Read more
OS X Yosemite Wallpaper 1.0 - Desktop im...
OS X Yosemite Wallpaper is the gorgeous new background image for Apple's upcoming OS X 10.10 Yosemite. This wallpaper is available for all screen resolutions with a source file that measures 5,418... Read more
Acorn 4.4 - Bitmap image editor. (Demo)
Acorn is a new image editor built with one goal in mind - simplicity. Fast, easy, and fluid, Acorn provides the options you'll need without any overhead. Acorn feels right, and won't drain your bank... Read more
Bartender 1.2.20 - Organize your menu ba...
Bartender lets you organize your menu bar apps. Features: Lets you tidy your menu bar apps how you want. See your menu bar apps when you want. Hide the apps you need to run, but do not need to... Read more
TotalFinder 1.6.2 - Adds tabs, hotkeys,...
TotalFinder is a universally acclaimed navigational companion for your Mac. Enhance your Mac's Finder with features so smart and convenient, you won't believe you ever lived without them. Tab-based... Read more

Latest Forum Discussions

See All

Take Note! Noteshelf Has Recieved a Big...
Take Note! Noteshelf Has Recieved a Big Update. Posted by Jessica Fisher on July 30th, 2014 [ permalink ] iPad Only App - Designed for the iPad | Read more »
Cubama Review
Cubama Review By Nadia Oxford on July 30th, 2014 Our Rating: :: TETRIIIIIS IIIIIN SPAAAAACE!Universal App - Designed for iPhone and iPad With its addictive challenge and interesting premise, Cubama is frantic screen-tapping fun.   | Read more »
Become a Guardians of Galactic Peace Wit...
Become a Guardians of Galactic Peace With the New Spacefaring Sim, Kairobotica. Posted by Jessica Fisher on July 30th, 2014 [ permalink ] | Read more »
Soul Guardians: Age of Midgard Review
Soul Guardians: Age of Midgard Review By George Fagundes on July 30th, 2014 Our Rating: :: SO MUCH GRIND IT CRUNCHESUniversal App - Designed for iPhone and iPad Swords and trading cards are fun, right? So is Soul Guardians: Age of... | Read more »
NFL Fantasy Football App Redesigned Ahea...
NFL Fantasy Football App Redesigned Ahead of Upcoming 2014 Season Posted by Ellis Spice on July 30th, 2014 [ permalink ] | Read more »
Matter Review
Matter Review By Jennifer Allen on July 30th, 2014 Our Rating: :: ORIGINAL PHOTO MANIPULATIONUniversal App - Designed for iPhone and iPad Matter lets you add geometric 3d shapes to your images and manipulate things so each image... | Read more »
Note Review
Note Review By Jennifer Allen on July 29th, 2014 Our Rating: :: TOO SIMPLEiPhone App - Designed for the iPhone, compatible with the iPad Note is a note taking app that’s a little too short on features to be worth its asking price... | Read more »
Chainsaw Warrior Goes on Sale & Ther...
Chainsaw Warrior Goes on Sale & There’s a Chance to Win a Copy of the Original Board Game Posted by Jennifer Allen on July 29th, 2014 [ permalink | Read more »
It Came From Canada: Tiny Tower Vegas
If you go to a casino, you might make a lot of money. If you run a casino, you’re guaranteed to make a lot of money. The choice seems pretty obvious. So while waiting for your shady real estate deals to move forward, get prepared with Tiny Tower... | Read more »
Z Hunter Review
Z Hunter Review By Lee Hamlet on July 29th, 2014 Our Rating: :: RIGHT ON TARGETUniversal App - Designed for iPhone and iPad While it might not necessarily break new ground, Z Hunter has enough tricks up its sleeve to ensure that... | Read more »

Price Scanner via MacPrices.net

13-inch 2.5GHz MacBook Pro on sale for $999,...
Best Buy has the 13″ 2.5GHz MacBook Pro available for $999.99 on their online store. Choose free shipping or free instant local store pickup (if available). Their price is $100 off MSRP. Price is... Read more
WaterField Unveils 15″ Outback Solo & 13″...
Hard on the heels of Apple’s refreshed MacBook Pro Retina laptops announcement, WaterField Designs has unveiled a 15-inch version of the waxed-canvas and leather Outback Solo and a 13-inch version of... Read more
New Roxio Toast 12 Delivers Digital Media Pow...
Roxio Toast 12 is a hub for sharing digital media to virtually any platform or device. has introduced two new additions to its Roxio Toast product family – Roxio Toast 12 Titanium and Roxio Toast 12... Read more
The lowest prices on leftover Retina MacBook...
Best Buy has dropped prices on leftover 13″ and 15″ Retina MacBook Pros by up to $300 off original MSRP on their online store for a limited time. Choose free local store pickup (if available) or free... Read more
Apple Updates MacBook Pro with Retina Display...
Apple today updated its MacBook Pro with Retina display with faster processors and double the amount of memory in both entry-level configurations. MacBook Pro with Retina display features a Retina... Read more
Up to $250 price drop on leftover 15-inch Mac...
B&H Photo has dropped prices on 2013 15″ Retina MacBook Pros by as much as $250 off original MSRP. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.3GHz Retina MacBook Pro: $2349... Read more
Updated MacBook Pro Price Trackers
We’ve updated our MacBook Pro Price Trackers with the latest information on prices, bundles, and availability on the new 2014 models from Apple’s authorized internet/catalog resellers as well as... Read more
Apple updates MacBook Pros with slightly fast...
Apple updated 13″ and 15″ Retina MacBook Pros today with slightly faster Haswell processors. 13″ models now ship with 8GB of RAM standard, while 15″ MacBook Pros ship with 16GB across the board. Most... Read more
Apple drops price on 13″ 2.5GHz MacBook Pro b...
The Apple Store has dropped their price for the 13″ 2.5GHz MacBook Pro by $100 to $1099 including free shipping. Read more
Apple drops prices on refurbished 2013 MacBoo...
The Apple Store has dropped prices on Apple Certified Refurbished 13″ and 15″ 2013 MacBook Pros, with model now available starting at $929. Apple’s one-year warranty is standard, and shipping is free... Read more

Jobs Board

Sr Software Lead Engineer, *Apple* Online S...
Sr Software Lead Engineer, Apple Online Store Publishing Systems Keywords: Company: Apple Job Code: E3PCAK8MgYYkw Location (City or ZIP): Santa Clara Status: Full 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
Sr. Product Leader, *Apple* Store Apps - 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 (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
*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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.