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

FotoMagico 5.4.1 - Powerful slideshow cr...
FotoMagico lets you create professional slideshows from your photos and music with just a few, simple mouse clicks. It sports a very clean and intuitive yet powerful user interface. High image... Read more
Espresso 3.0 - Powerful HTML, XML, CSS,...
Espresso is back. For people who make delightful, innovative, and fast websites -- in an app to match. Espresso helps you write, code, design, build, and publish with flair and efficiency.... Read more
Spotify 1.0.51.693. - Stream music, crea...
Spotify is a streaming music service that gives you on-demand access to millions of songs. Whether you like driving rock, silky R&B, or grandiose classical music, Spotify's massive catalogue puts... Read more
Gutenprint 5.2.12 - Quality drivers for...
Gutenprint is a suite of printer drivers that may be used with most common UNIX print spooling systems, including CUPS, lpr, LPRng, or others. Gutenprint currently supports over 2000 printer models.... Read more
Firefox 52.0.2 - Fast, safe Web browser.
Firefox 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 casual... Read more
Google Chrome 57.0.2987.133 - Modern and...
Google Chrome is a Web browser by Google, created to be a modern platform for Web pages and applications. It utilizes very fast loading of Web pages and has a V8 engine, which is a custom built... Read more
RapidWeaver 7.3.3 - Create template-base...
RapidWeaver is a next-generation Web design application to help you easily create professional-looking Web sites in minutes. No knowledge of complex code is required, RapidWeaver will take care of... Read more
Chromium 57.0.2987.133 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. Version 27.0.2987.133: Note: This update has no Flash... Read more
Lyn 1.8.8 - Lightweight image browser an...
Lyn is a fast, lightweight image browser and viewer designed for photographers, graphic artists, and Web designers. Featuring an extremely versatile and aesthetically pleasing interface, it delivers... Read more
Adobe Animate CC 2017 16.2.0 - Advanced...
Animate CC 2017 is available as part of Adobe Creative Cloud for as little as $19.99/month (or $9.99/month if you're a previous Flash Professional customer). Animate CC 2017 (was Flash CC) lets you... Read more

Dynasty Warriors: Unleashed arrives on m...
No one does mindless hack and slash quite like a Musou game. What's more fun than single-handedly chopping your way through hundreds of enemies? Now, for the first time ever, that unrivaled experience goes mobile with Dynasty Warriors: Unleashed.... | Read more »
Crash of Cars beginner's guide
Crash of Cars is a fun new entry in the realm of multiplayer beat 'em ups. It's basically bumper cars off the rails -- players drive around in vehicles of their choosing -- anything from a mini-van to the weinermobile in all of its glory --... | Read more »
Dynasty Blades new update introduces a n...
Sharpen your weapons -- Dynasty Blades is back with new and improved hack n’ slash stylings. The Romance of the Three Kingdoms-inspired action MMORPG introduces a bunch of fun new features in its latest update. For the uninitiated, Dynasty Blades... | Read more »
Meganoid(2017) (Games)
Meganoid(2017) 1.0 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0 (iTunes) Description: LAUNCH DISCOUNT 20% UNTIL APRIL 2nd! Support, tip and tricks: http://www.orangepixel.net/forum/ Subscribe to our newsletter... | Read more »
Telltale's Guardians of the Galaxy...
Telltale will be releasing their rendition of Guardians of the Galaxy later this month. The first episode, Tangled Up in Blue, features familiar faces including Star-Lord, Groot, Rocket, Gamora, and Drax. If the first episode's title is any... | Read more »
Royal Dungeon (Games)
Royal Dungeon 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: The king and his queen are trapped in their castle which suddenly turned out as a very dangerous place. The goal is to escape... | Read more »
Tom Clancy's ShadowBreak is a real-...
Ubisoft is treating Tom Clancy fans to the series' very first mobile-exclusive game in ShadowBreak, a real-time, multiplayer shooter in which players snipe at enemies in fast-paced tactics-driven combat. [Read more] | Read more »
Power Rangers: Legacy Wars beginner...
Rita Repulsa is back, but this time she's invading your mobile phone in Power Rangers: Legacy Wars. What looks to be a straightforward beat 'em up is actually a tough-as-nails multiplayer strategy game that requires some deft tactical maneuvering.... | Read more »
Hearthstone celebrates the upcoming Jour...
Hearthstone gets a new expansion, Journey to Un'Goro, in a little over a week, and they'll be welcoming the Year of the Mammoth, the next season, at the same time. There's a lot to be excited about, so Blizzard is celebrating in kind. Players will... | Read more »
4 smart and stylish puzzle games like Ty...
TypeShift launched a little over a week ago, offering some puzzling new challenges for word nerds equipped with an iOS device. Created by Zach Gage, the mind behind Spelltower, TypeShift boasts, like its predecessor, a sleak design and some very... | Read more »

Price Scanner via MacPrices.net

Deal alert! 13-inch 2.0GHz MacBook Pros now f...
B&H Photo has lowered their price on 13″ Apple 2.0GHz MacBook Pros to $225 off MSRP through midnight tonight (3/30/17). Shipping is free, and B&H charges NY sales tax only: - 13″ 2.0GHz... Read more
1.4GHz Mac mini on sale for $399, $100 off MS...
B&H Photo has the 1.4GHz Mac mini on sale for $100 off MSRP including free shipping plus NY sales tax only: - 1.4GHz Mac mini: $399 $100 off MSRP Sale ends on March 31st. Read more
13-inch 128GB MacBook Air on sale for $849, s...
B&H Photo has lowered their price on the 13″ 1.6GHz/128GB MacBook Air to $849, or $150 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 1.6GHz/128GB MacBook Air (MMGF2LL/A... Read more
Is Apple Planning An iPhone Based Modular Doc...
Today’s more powerful and larger-screened smartphones and phablets are becoming the default anchor computing device for more and more users computing devices, but even a five or six inch panel is not... Read more
Razer Launches New Razer Blade Pro World’s Fi...
Razer, the gaming and high performance hardware specialists, have announced the new Razer Blade Pro laptop — the first laptop to be qualified for THX Mobile Certification, an accreditation reserved... Read more
Gro CRM’s Apple Small Business Mac And iOS CR...
Gro Software, developers of the Mac CRM software for small business and enterprise, are included in FinancesOnline 2017 CRM Rising Stars and Great User Experience lists by business software review... Read more
Deal alert! 15-inch and 13-inch MacBook Pros...
B&H Photo has the new 2016 15″ and 13″ Apple MacBook Pros in stock today and on sale for up to $200 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.7GHz Touch Bar... Read more
Save up to $420 on a new MacBook Pro with App...
Apple is offering Certified Refurbished 2016 15″ and 13″ MacBook Pros, including some Touch Bar models, for up to $420 off original MSRP. An Apple one-year warranty is included with each model, and... Read more
12-inch 1.2GHz Retina MacBooks on sale for $1...
B&H has 12″ 1.2GHz Retina MacBooks on sale for up to $200 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 12″ 1.2GHz Space Gray Retina MacBook: $1449 $150 off MSRP - 12″ 1.... Read more
Is A New 10.5-inch iPad Still Coming In April...
There was no sign or mention of a long-rumored and much anticipated 10.5-inch iPad Pro in Apple’s product announcements last week. The exciting iPad news was release of an upgraded iPad Air with a... Read more

Jobs Board

Fulltime aan de slag als shopmanager in een h...
Ben jij helemaal gek van Apple -producten en vind je het helemaal super om fulltime shopmanager te zijn in een jonge en hippe elektronicazaak? Wil jij werken in Read more
Fulltime aan de slag als shopmanager in een h...
Ben jij helemaal gek van Apple -producten en vind je het helemaal super om fulltime shopmanager te zijn in een jonge en hippe elektronicazaak? Wil jij werken in Read more
Fulltime aan de slag als shopmanager in een h...
Ben jij helemaal gek van Apple -producten en vind je het helemaal super om fulltime shopmanager te zijn in een jonge en hippe elektronicazaak? Wil jij werken in Read more
Desktop Analyst - *Apple* Products - Montef...
…technology to improve patient care. JOB RESPONSIBILITIES: Provide day-to-day support for Apple Hardware and Software in the environment based on the team's support Read more
*Apple* Mobile Master - Best Buy (United Sta...
**493168BR** **Job Title:** Apple Mobile Master **Location Number:** 000827-Denton-Store **Job Description:** **What does a Best Buy Apple Mobile Master do?** At Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.