TweetFollow Us on Twitter

Date FKEY
Volume Number:9
Issue Number:2
Column Tag:Pascal/FKEY

Related Info: Event Manager

A Date-Typing FKEY

A one hour project

By Rob Spencer, East Lyme, Connecticut

This is a one-hour project with two goals: first, to provide a minor but useful tidbit for everyday use, and second, to present a short example of an FKEY that posts and modifies its own events.

For newcomers, an FKEY is a small routine that’s invoked when the user types a command-shift-number sequence, such as the command-shift-3 FKEY that captures the screen to a MacPaint document (under System 6) or Teach Text PICT document (System 7). An FKEY consists of stand-alone code with no global variables and usually little or no user interface; see Roy Lovejoy’s recent article (“FKEYs in THINK Pascal, Easy...”, MacTutor, June 1992, p. 53-55) for more discussion.

This FKEY does something simple and useful for those of us who type letters and memos every day: when the user types command-shift-6 (or whatever number from 0 to 9 you choose), the FKEY types the current date into the current document or edit field. It does this by getting the date from the Toolbox and sending it to the event queue as a sequence of keyDown events. The text appears in your document exactly as if you had typed it.

ASSEMBLE THE EVENT

The heart of the FKEY is the SendAString routine that posts each character of its input string as a keyDown event for the current application to catch. All that’s necessary is to assemble the appropriate message (a longint) for each character.

The low byte of message is charCode, which is just ord(theStr[i]). The next byte is the keyCode, which specifies which key was pressed. For most uses keyCode can be zero, since most keyDown dispatch routines ignore the keyCode and look only at charCode, like this:

with myEvent do begin
 myChar := CHR(BitAnd(message, charCodeMask));
 if BitAnd(modifiers, cmdKey) <> 0 then...

However, my testing with keyCode = 0 showed that some applications didn’t receive the proper string, so to be safe I had to do a little more work to fill in the correct keyCode byte.

Key codes are defined in the System’s KCHR resource, but rather than retrieve and parse that, we use a small bit of it in a fixed look-up table string (called keyMap in the listing). This contains the correct keyCode values for all letters, numbers, and the comma. The space character is handled separately, rather than make keyMap too long. Finally, keyCode is shifted to the second byte and added to charCode to produce the correct message.

REMOVE THOSE MODIFIERS

In the first version of the FKEY I simply used PostEvent and got unexpected results: since the user must have the command and shift keys down to invoke the FKEY, the keyDown events that it posts come with the cmdKey and shiftKey modifier bits set. Thus if the month is September, the first keyDown that the application sees will be command-S, and it will promptly save the current document! What we want is the FKEY to send the keyDowns without any modifiers; the solution is to use PPostEvent and then clear the appropriate bits from the new event, as shown in the listing.

TESTING and DEBUGGING

As both Roy Lovejoy and the THINK Pascal demo FKEY “BlockComment” point out, debugging an FKEY is simple. Just build a tiny program that includes the FKEY unit and then call the obligatory FKEY entry point called main. In my program I then use THINK’s Text window to receive the keyDown events, so we can see what day it is.

USING THE FKEY

Use ResEdit to paste the FKEY resource into the word processing application of your choice, or, if you want the FKEY universally available, paste it into the System file. That’s it!

BUT WAIT, THERE’S MORE!

Though FKEY’s are as old as the Mac, they aren’t widely appreciated. Perhaps this is partly because of what I just wrote above: “Use ResEdit...”. I decided to provide an easier way, though for the sake of brevity I’ll only mention it here: on the code disk for this month is a HyperCard stack which does a one-button installation of the FKEY to your System file.

Figure 1: bonus installation stack

This stack does this job with an original XFCN and XCMD. The XFCN, SystemResources, returns a list of System resources of a given type (to see if the FKEY already exists), while the XCMD, InstallFKEY, does the actual installation. The stack also includes the THINK Pascal source code for these externals.

LISTINGS
unit DateFKEY;
{ Types today’s date when the user types }
{ cmd-shift-6. In THINK Pascal 4.0 by    }  
{ Rob Spencer, August 1992.              }

interface

 procedure main;

implementation

 procedure main;

 { ----------------------------- }

 function SendAString (theStr: str255): OSErr;

 const
 { keyMap is a subset of the }
 { KCHR System resource.     }
 keyMap = 
 'ASDFHGZXCV*BQWERYT123465=97*80*OU*IP*LJ*K**,*NM';
 space = char(32);

 var
 i, keyCode: integer;
 theChar: char;
 theErr: OSErr;
 message, modifiers, modifierMask: longint;
 myQPtr: EvQElPtr;

 begin
 theErr := noErr;
 modifierMask := BitNot(shiftKey + cmdKey);

 if theStr <> '' then
 begin
 FlushEvents(keyDown, 0);
 for i := 1 to length(theStr) do
 begin
 { Get the proper keyCode. }
 theChar := theStr[i];
 if theChar in ['a'..'z'] then
 { Make theChar uppercase for }
 { our look-up string.        }
 theChar := char(ord(theChar) - 32);
 if theChar = space then
 keyCode := $31
 else
 keyCode := pos(theChar, keyMap) - 1;
 if keyCode = -1 then
 keyCode := 0;

 { Assemble the message.   }
 message := BitShift(keyCode, 8) +
 ord(theStr[i]);

 { Post the keyDown event. }
 theErr := PPostEvent(keyDown, message,
 myQPtr);
 if theErr <> noErr then
 leave;

 { Now strip off the cmdKey }
 { and shiftKey modifiers.  }
 modifiers := BitAnd(myQPtr^.evtQModifiers, 
 modifierMask);
 myQPtr^.evtQModifiers := modifiers;
 end;
 end;
 SendAString := theErr;
 end;

 { ============== main ============== }

 var
 dateStr: str255;
 tempLong: longint;

 begin
 { The queue can only hold 20 characters, }
 { so we strip off the day of the week.   }
 GetDateTime(tempLong);
 IUDateString(tempLong, LongDate, dateStr);
 if dateStr <> '' then
 if pos(char(32), dateStr) > 0 then
 Delete(dateStr, 1, pos(char(32), dateStr));
 if SendAString(dateStr) <> noErr then
 SysBeep(10);
 end;

end.

{ ====== shell program for debugging ===== }

program DateFKEYtest;

 uses
 DateFKEY;

 var
 myStr: str255;

begin
 main;  { Call our FKEY }
 { Make an active input window    }
 { to receive the keyDown events. }
 ShowText;
 read(myStr);
 writeLn;
 writeLn(myStr);
end.

{ =========== end of listings =========== }

Figure 2: the project window for debugging

Figure 3: the project window for the stand-alone FKEY

Figure 4: set up for FKEY #6.

 
AAPL
$102.43
Apple Inc.
+2.67
MSFT
$44.84
Microsoft Corpora
+0.76
GOOG
$524.82
Google Inc.
+3.98

MacTech Search:
Community Search:

Software Updates via MacUpdate

RapidWeaver 6.0 - Create template-based...
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
NTFS 12.0.39 - Provides full read and wr...
Paragon NTFS breaks down the barriers between Windows and OS X. Paragon NTFS effectively solves the communication problems between the Mac system and NTFS, providing full read and write access to... Read more
RestoreMeNot 2.0.3 - Disable window rest...
RestoreMeNot provides a simple way to disable the window restoration for individual applications so that you can fine-tune this behavior to suit your needs. Please note that RestoreMeNot is designed... Read more
Macgo Blu-ray Player 2.10.9.1750 - Blu-r...
Macgo Mac Blu-ray Player can bring you the most unforgettable Blu-ray experience on your Mac. Overview Macgo Mac Blu-ray Player can satisfy just about every need you could possibly have in a Blu-ray... Read more
Apple iOS 8.1 - The latest version of Ap...
The latest version of iOS can be downloaded through iTunes. Apple iOS 8 comes with big updates to apps you use every day, like Messages and Photos. A whole new way to share content with your family.... Read more
TechTool Pro 7.0.5 - Hard drive and syst...
TechTool Pro is now 7, and this is the most advanced version of the acclaimed Macintosh troubleshooting utility created in its 20-year history. Micromat has redeveloped TechTool Pro 7 to be fully 64... Read more
PDFKey Pro 4.0.2 - Edit and print passwo...
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
Yasu 2.9.1 - System maintenance app; per...
Yasu was originally created with System Administrators who service large groups of workstations in mind, Yasu (Yet Another System Utility) was made to do a specific group of maintenance tasks... Read more
Hazel 3.3 - Create rules for organizing...
Hazel is your personal housekeeper, organizing and cleaning folders based on rules you define. Hazel can also manage your trash and uninstall your applications. Organize your files using a... Read more
Autopano Giga 3.7 - Stitch multiple imag...
Autopano Giga allows you to stitch 2, 20, or 2,000 images. Version 3.0 integrates impressive new features that will definitely make you adopt Autopano Pro or Autopano Giga: Choose between 9... Read more

Latest Forum Discussions

See All

Fiete – A Day on a Farm Review
Fiete – A Day on a Farm Review By Amy Solomon on October 21st, 2014 Our Rating: :: A MEMORABLE EXPERIENCEUniversal App - Designed for iPhone and iPad Fiete – A day on a farm in an interactive app for young children full of... | Read more »
Tilt to Live: Gauntlet’s Revenge is Almo...
Tilt to Live: Gauntlet’s Revenge is Almost Here Posted by Jessica Fisher on October 21st, 2014 [ permalink ] One Man Left has announced the official release date of Tilt to Live: Gauntlet’s Re | Read more »
Sago Mini Monsters Celebrates Halloween...
Sago Mini Monsters Celebrates Halloween with Fun Costumes and Special Treats. Posted by Jessica Fisher on October 21st, 2014 [ permal | Read more »
Inferno 2 Review
Inferno 2 Review By Andrew Fisher on October 21st, 2014 Our Rating: :: TWIN STICK GOODNESSUniversal App - Designed for iPhone and iPad With tight controls and awesome, stark visuals, Inferno 2 is loads of fun.   | Read more »
Clips Review
Clips Review By Jennifer Allen on October 21st, 2014 Our Rating: :: CONVENIENT PASTINGUniversal App - Designed for iPhone and iPad Making copying and pasting more powerful than usual, Clips is a great way to move stuff around.   | Read more »
MonSense Review
MonSense Review By Jennifer Allen on October 21st, 2014 Our Rating: :: ORGANIZED FINANCESiPhone App - Designed for the iPhone, compatible with the iPad Organize your finances with the quick and easy to use, MonSense.   | Read more »
This Week at 148Apps: October 13-17, 201...
Expert App Reviewers   So little time and so very many apps. What’s a poor iPhone/iPad lover to do? Fortunately, 148Apps is here to give you the rundown on the latest and greatest releases. And we even have a tremendous back catalog of reviews; just... | Read more »
Angry Birds Transformers Review
Angry Birds Transformers Review By Jennifer Allen on October 20th, 2014 Our Rating: :: TRANSFORMED BIRDSUniversal App - Designed for iPhone and iPad Transformed in a way you wouldn’t expect, Angry Birds Transformers is a quite... | Read more »
GAMEVIL Announces the Upcoming Launch of...
GAMEVIL Announces the Upcoming Launch of Mark of the Dragon Posted by Jessica Fisher on October 20th, 2014 [ permalink ] Mark of the Dragon, by GAMEVIL, put | Read more »
Interview With the Angry Birds Transform...
Angry Birds Transformers recently transformed and rolled out worldwide. This run-and-gun title is a hit with young Transformers fans, but the ample references to classic Transformers fandom has also earned it a place in the hearts of long-time... | Read more »

Price Scanner via MacPrices.net

Select MacBook Airs $100 off MSRP, free shipp...
B&H Photo has 2014 a couple of MacBook Airs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only. They also include free copies of Parallels Desktop and LoJack for... Read more
13-inch 2.5GHz MacBook Pro on sale for $100 o...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $999.99 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Read more
Strong iPhone, Mac And App Store Sales Drive...
Apple on Monday announced financial results for its fiscal 2014 fourth quarter ended September 27, 2014. The Company posted quarterly revenue of $42.1 billion and quarterly net profit of $8.5 billion... Read more
Apple Posts How-To For OS X Recovery
OS X 10.7 Lion and later include OS X Recovery. This feature includes all of the tools you need to reinstall OS X, repair your disk, and even restore from a Time Machine backup. OS X Recovery... Read more
Mac OS X Versions (Builds) Supported By Vario...
Apple Support has posted a handy resource explaining which Mac OS X versions (builds) originally shipped with or are available for your computer via retail discs, downloads, or Software Update. Apple... Read more
Deals on 2011 13-inch MacBook Airs, from $649
Daily Steals has the Mid-2011 13″ 1.7GHz i5 MacBook Air (4GB/128GB) available for $699 with a 90 day warranty. The Mid-2011 13″ 1.7GHz i5 MacBook Air (4GB/128GB SSD) is available for $649 at Other... Read more
2013 15-inch 2.0GHz Retina MacBook Pro availa...
B&H Photo has leftover previous-generation 15″ 2.0GHz Retina MacBook Pros now available for $1599 including free shipping plus NY sales tax only. Their price is $400 off original MSRP. B&H... Read more
Updated iPad Prices
We’ve updated our iPad Air Price Tracker and our iPad mini Price Tracker with the latest information on prices and availability from Apple and other resellers, including the new iPad Air 2 and the... Read more
Apple Pay Available to Millions of Visa Cardh...
Visa Inc. brings secure, convenient payments to iPad Air 2 and iPad mini 3as well as iPhone 6 and 6 Plus. Starting October 20th, eligible Visa cardholders in the U.S. will be able to use Apple Pay,... Read more
Textkraft Pocket – the missing TextEdit for i...
infovole GmbH has announced the release and immediate availability of Textkraft Pocket 1.0, a professional text editor and note taking app for Apple’s iPhone. In March 2014 rumors were all about... Read more

Jobs Board

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
*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
Position Opening at *Apple* - Apple (United...
…customers purchase our products, you're the one who helps them get more out of their new Apple technology. Your day in the Apple Store is filled with a range of Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.