TweetFollow Us on Twitter

Key Mapper
Volume Number:2
Issue Number:10
Column Tag:Forth Forum

Keyboard Re-Mapper Utility

By Jörg Langowski, MacTutor Editorial Board

Keyboard configuration and reconfiguration

This time I'd like to address a problem that is rather neglected in Inside Macintosh, but not by MacTutor, and that is the configuration of the Mac keyboard. [As background, you may wish to refer to the August issue for an article by Joel West and David Smith on the Keyboard Sleuth.] The section on international resources mentions the different existing keyboards, their layouts and the keycodes; but it is nowhere said explicitly how the keycode that is sent out when a key is pressed is mapped to an ASCII character and where the tables are kept that are used for that assignment.

There is one program, the Localizer, that is generally used to change the keyboard configuration from one layout to another. This works well for the standard keyboards that come for the different countries in which the Mac is sold. It would be very convenient, though, to be able to change the keyboard mapping according to one's taste. That way one could layout a Dvorak keyboard or make simple changes just to have some different symbols available, without changing the whole keyboard arrangement. As an example, I prefer to have a decimal point instead of a comma on my (German) Mac+ numeric keypad, without changing the rest of the layout so that all the symbols stay where they are. There is no 'canned' configuration in the localizer that provides for this change. So, here's a nice chance to write a small application in Forth that does something useful and at the same time show some instructive details about how the keyboard is configured.

The INIT 0 and INIT 1 resources

Doing so requires some NOSYing around in the routines that translate keycodes into ASCII characters. These routines are built at system initialization time through the INIT resources ID=0 and ID=1. [One can find this out easily by looking at the Localizer, which contains quite a few INIT resources that all look very much the same except for some tables that contain the actual keyboard mapping]. Disassembly reveals how a keycode is translated into an ASCII character by the INIT routines. See Listing 1. The modifier bits (Shift, Option, Caps Lock) are taken as an index into a small offset table, from which the beginning of the actual translation table is obtained. The keycode then serves as an index into that table. Two different translation tables exist for the old Mac and the Mac+ keyboards. The keyboard type is read from the system global KybdType at $21E, which is continually being updated by the background routine that checks for the presence of a keyboard. A hex $B here means we have a Mac+ keyboard plugged in, other numbers so far refer to the old keyboard, and keypad, optionally. [A zero means, there is no keyboard... but in that case, we'll never get to this routine anyway...]

A very simple way to change the translation table to our preferences is to emulate the table lookup process in Forth, starting with the keycode. Mach1 (also the new version Mach2) contains the word ?TERMINAL which returns the character code, keycode and modifier flags if a key has been pressed.

Fig. 1 Our Keyboard Remapper in Mach2

Listing 2 defines a couple of words that will return the absolute address of the translation table entry from the keycode and modifiers. keycode and modifiers return the respective fields. keyaddress, given a modifier / keycode input on the stack, determines which INIT resource to use (INIT 0 for the main keyboard and INIT 1 for the numeric keypad), leaves a handle to that resource on the stack and the table entry's address on top of it. This address can then be used by the remapping routine to put a new entry into the table. The handle will be used to call _ChangedResource to mark the INIT resource as changed so that it is rewritten when _UpdateResource is called at the end.

get.key1.data and get.key2.data are words that are used by keyaddress to determine the beginning of the translation tables for the main and numeric keyboards. They are somewhat kludgy as they make use of the internal structure of the INIT 0 and INIT1 resource codes, reading the table addresses out of the LEA <data>,A0 instructions at the beginning of the code. When a system is released where those instructions occur in different positions, my program will get completely lost. In that case, it would either have to be modified to accommodate the new addresses or the kludge would have to be generalized, using a routine that looks for a LEA <data>,A0 instruction. All this is embarassingly bad programming style, but it was the simplest way that I could think up to find the table addresses.

The INIT resources are read once at the beginning of the main word remap and stored in two variables hand0 and hand1. remap itself is an endless loop which comprises the user dialog for remapping of the keys. When the user hits the go-away box, the loop is exited through a vector which is installed in the task's goaway-hook; the resource file is updated (file id=0 indicates the System file), and control is returned to the Finder.

The program can be compiled into a standalone application through the normal turnkey process built into Mach1; a turnkeyed version can be found on the MacTutor source disk.

While the remapper is being used, the INIT resources already in memory from boot-up will of course stay as they are. Only the copies of INIT 0 and INIT 1 in the present System file are changed and rewritten. This means that your keyboard will stay in its old configuration until you reboot with the disk that contains the changed System file.

Mach2, assembler bug, etc.

The new version of Mach - Mach2 - has been released a long time ago as you read this. As I write this, however, I have just taken a short look at the changes and improvements that have been made. The main change for execution speed is that the DO...LOOP index and limit have been moved from the loop stack into registers (only the innermost loop). This speeds up loop execution tremendously, so that the famous Sieve now executes in just about seven and one half seconds, which is only one second slower than TML Pascal code. Another benchmark I wrote that does 50 screen inversions (explicitly, without calling InvertRect) also executes only about 15% slower than Pascal code.

The disadvantage is that many more registers are now being internally used by the Mach2 system. In fact, Palo Alto Shipping warned me not to use any registers in CODE definitions without saving and restoring them. Therefore, if you try to use the floating point routines or many of the other examples that you could find here with Mach2, you're likely to be disappointed. Inserting MOVEM.L A0-A4/D0-D7,-(A7) and MOVEM.L (A7)+, A0-A4/D0-D7 in strategic places will help tremendously to fight frustration in that case.

The assembler bug which caused faulty coding of some instructions (seeV2#8) has been fixed, and they even promised that the Forth debugger would work Real Soon Now. Meanwhile, TMON is still the best way to debug with Mach2.

Where did the $%&§ output go...

A multitasking system like Mach has its peculiarities, which have to be learned. Somebody from the local developer's group had problems getting Quickdraw calls drawing into a window he had set up in Mach1. When he would turnkey the program, however, everything would work fine. It seemed like under some circumstances, with the Mach1 system window open, the system would use a different grafPort from what he thought.

There is a rather simple explanation to this problem. Mach1 keeps a flashing cursor going in any window in which QUIT, the interpreter main loop, is running, which causes the current port to be reset to that window's grafPort. It is the programmer's responsibility to make sure that the currently active grafPort is the one that one wants to use. Since any task keeps a pointer to its associated window in a user variable, this is easy to achieve by doing a _setPort to this window. (One could argue that the task scheduler should automatically reset the current port to the task's own window. In my opinion, that would not be a good idea, since it would create a lot of overhead on switching tasks. Furthermore, the task actually might want to use another grafPort, this would make the initial resetting unnecessary anyway.)

Listing 1: excerpts from the INIT0 and INIT1 key translation routines
;
; alphanumeric keyboard translator, Apple System File
;
INIT0  BRA     com_1 ; setup jump vector

proc2    BRA.S   lac_2
data1    DC.W    $FFFF,$4B45,$5943,1,$301,0

proc3    LEA     data8,A0    ; Mac+ translate table
 CMPI.B  #11,KybdType ; 11 = Mac+
 BEQ.S   lac_1
  LEA     data9,A0    ; old Mac translate table
lac_1    MOVEQ   #7,D0
 AND     D1,D0
 ADD     D0,D0 ; modifier byte*2
 MOVE    0(A0,D0.W),D0 ; offset for modifiers 
 ADD     D2,D0
 MOVE.B  0(A0,D0.W),D0 ; table entry
 RTS     

lac_2    CMPI    #52,D2 ; main entry point, D2 contains keycode
 BHI.S   lac_3  ; was modifier key pressed?
 BSR     proc3  ; if not, translate through table
 TST.B   KeyMap+6
 BPL.S   lac_4 ; if no control key
 BTST    #0,D1 ; shift pressed?
 BEQ.S   lac_4
 BTST    #2,D1 ; option pressed?
 BNE.S   lac_4
 BCLR    #0,D1 ; clear shift bit
 BSR     proc3  ; and retranslate
 CMPI.B  #48,D0 ; is it
 BCS.S   lac_4 ; a number key?
   CMPI.B  #57,D0
 BHI.S   lac_4
 TST.B   D3
 BMI.S   lac_4
 TST.B   ScrDmpEnb ; deal with FKEYs
 BEQ.S   lac_4
 SUBI.B  #48,D0
 MOVE.B  D0,ScrDmpType
lac_3    MOVEQ   #0,D0
lac_4    .
 .
 . ( code that deals with diacritical marks,
 .  etc. etc. )
 .
 RTS
 .

data8    ; Mac+ key translate table (German keyboard)
 DC.W    $10,$45,$7A,$45,$AF,$E4,$119,$E4
 ; ( offsets for modifier keys)
  DC.W    $6173,$6466,$6867,$7978,$6376,$62,$7177,$6572

  DC.W    $AEC6,$CEB2,$B0D0,$7EB5,$C909,$CAD4,$800

data9    ; Old Mac key translate table (German keyboard)
 DC.W    $10,$45,$7A,$45,$AF,$E4,$119,$E4
 ; ( offsets for modifier keys)
  DC.W  $6173,$6466,$6867,$3C79,$7863,$2D76,$7177, $6572
 .
 . ( DC.W offsets for modifiers etc.)
 .
  
  DC.W    $AEF1,$CE0D,$F7C9,$F5F6,$F809,$3D4,$8CA
                                         
com_1    LEA     proc2,A0
 MOVE.L  A0,Key1Trans  ; $29E
 RTS 
;    
; numeric keypad translator
;
INIT1  BRA     com_1 ; setup jump vector
proc2    LEA     data1,A0    ; translate table
 CMPI.B  #11,KybdType ; 11 = Mac+
 BEQ.S   lac_1
 ADDA.W  #64,A0 ; offset for old Mac
lac_1    LSR     #1,D1
 BCC.S   lac_2
 ADDA.W  #32,A0 ; offset for shift key
lac_2    ANDI.B  #$1F,D2
 MOVE.B  0(A0,D2.W),D0 ; get table entry
 RTS                                             
data1    DC.W    $2C,$1D00,0,$1C1B,$1F00,0,$31E,$2D00
  DC.W    0,$3031,$3233,$3435,$3637,$38,$3900,0
  DC.W    $2E,$2A00,0,$2B1B,$3D00,0,$32F,$2D00
  DC.W    0,$3031,$3233,$3435,$3637,$38,$3900,0
  DC.W    $2C,$1D00,0,$1C1B,$1F00,0,$31E,$2D00
  DC.W    0,$3031,$3233,$3435,$3637,$38,$3900,0
  DC.W    $2C,$2A00,0,$2B1B,$2E00,0,$32F,$2D00
  DC.W    0,$3031,$3233,$3435,$3637,$38,$3900,0
                                         
com_1    LEA     proc2,A0
 MOVE.L  A0,Key2Trans
 RTS                                          
 END     
Listing 2: Reconfiguring the Keyboard routines INIT 0 and INIT 1
( Keyboard reconfigurator, c 1986 J. Langowski / MacTutor )
( For reconfiguration of individual keys without using the Localizer 
)

only forth also assembler also mac

hex
494e4954 constant "init
21e constant keyb.type  ( B: Mac+ )
variable hand0  variable hand1

: get.handles
 "init 0 call getresource hand0 !
 "init 1 call getresource hand1 !
;
: get.key1.data ( | handle start.of.data )
 hand0 @ dup @ 7fffff and 14 + 
 keyb.type c@ B <> if C + then  dup w@ +
;
: get.key2.data ( | handle start.of.data )
 hand1 @ dup @ 7fffff and 6 + dup w@ +
 keyb.type c@ B <> if 40 + then  
;
: keyin
 begin 2d emit 8 emit ?terminal ?dup until
;
: keycode ( extracts keycode out of keyinfo )
 100 / ff and ;

: modifiers ( extracts modifiers from keyinfo )
 1000000 / ff and ;

: keyaddress { | mods keyc -- handle offset }
 dup  modifiers -> mods  keycode -> keyc
 keyc 41 < if get.key1.data 
 dup mods E and + w@ + keyc + 
   else get.key2.data 
 mods 2 and
 if ( shift key down) 20 + then
 keyc 1f and +
   then
;
: keytest
 begin keyin keyaddress c@ emit key drop drop again 
;
: get&show ( | handle offset )
 keyin dup key emit ."  - Keycode = " 
 dup modifiers swap keycode . 
 ." , Modifiers = " binary 
 <# # # # # #> type decimal 
 keyaddress dup c@ 
 ." , actual mapping - " emit cr
;
: keynum cr 
 begin get&show drop drop again
;
decimal

: hello 
 cls
 ." Macintosh Keyboard Remapper" cr
 ." © 1986 J.Langowski / MacTutor" cr cr
 ." Closing the window will update the resource file." cr cr
;
: yesno begin key dup emit 
 case 
 89 of 1 1 endof  121 of 1 1 endof
 78 of 0 1 endof  110 of 0 1 endof
 cr ." y or n - " 0 swap
 endcase
   until
;
: on.goaway 0 call updateresfile bye ;
 
: remap
 hello 
 get.handles
 begin
 ." Type the key you'd like to change - " cr
 get&show ( | handle offset )
 ." Do you want to remap this key (y/n) - " yesno cr
 if 
 ." Enter the character to map this key to - "
 key dup emit cr 
 swap c! 
     ( store in mapping table of INIT resource)
 call changedresource
 else 2drop
 then cr
 again
;
 
164 user goaway-hook

NEW.WINDOW remapper
" Keyboard Configuration Editor" remapper TITLE
50 20 316 496 remapper BOUNDS
ROUNDED VISIBLE CLOSEBOX NOGROWBOX 
 remapper ITEMS
600 5000 terminal mapper

: go.map activate remap ;

: start
 remapper add
 remapper mapper build
 ['] on.goaway goaway-hook task-> mapper !
 remapper dup call selectwindow call setport
 mapper go.map
; 
 
AAPL
$116.47
Apple Inc.
+0.16
MSFT
$47.98
Microsoft Corpora
-0.72
GOOG
$537.50
Google Inc.
+2.67

MacTech Search:
Community Search:

Software Updates via MacUpdate

Cobook 3.0.7 - Intelligent address book....
Cobook Contacts is an intuitive, engaging address book. Solve the problem of contact management with Cobook Contacts and its simple interface and powerful syncing and integration possibilities.... Read more
StatsBar 1.9 - Monitor system processes...
StatsBar gives you a comprehensive and detailed analysis of the following areas of your Mac: CPU usage Memory usage Disk usage Network and bandwidth usage Battery power and health (MacBooks only)... Read more
Cyberduck 4.6 - FTP and SFTP browser. (F...
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
Maya 2015 - Professional 3D modeling and...
Maya is an award-winning software and powerful, integrated 3D modeling, animation, visual effects, and rendering solution. Because Maya is based on an open architecture, all your work can be scripted... Read more
Evernote 6.0.1 - Create searchable notes...
Evernote allows you to easily capture information in any environment using whatever device or platform you find most convenient, and makes this information accessible and searchable at anytime, from... Read more
calibre 2.11 - Complete e-library manage...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital... Read more
Herald 5.0.1 - Notification plugin for M...
Note: Versions 2.1.3 (for OS X 10.7), 3.0.6 (for OS X 10.8), and 4.0.8 (for OS X 10.9) are no longer supported by the developer. Herald is a notification plugin for Mail.app, Apple's Mac OS X email... Read more
Firetask 3.7 - Innovative task managemen...
Firetask uniquely combines the advantages of classical priority-and-due-date-based task management with GTD. Stay focused and on top of your commitments - Firetask's "Today" view shows all relevant... Read more
TechTool Pro 7.0.6 - 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
PhotoDesk 3.0.1 - Instagram client for p...
PhotoDesk lets you view, like, comment, and download Instagram pictures/videos! (NO Uploads! / Image Posting! Instagram forbids that! AND you *need* an *existing* Instagram account). But you can do... Read more

Latest Forum Discussions

See All

Ubisoft Gives Everyone Two New Ways to E...
Ubisoft Gives Everyone Two New Ways to Earn In-Game Stuff for Far Cry 4 Posted by Jessica Fisher on November 21st, 2014 [ permalink ] | Read more »
Golfinity – Tips, Tricks, Strategies, an...
Dig this: Would you like to know what we thought of being an infinite golfer? Check out our Golfinity review! Golfinity offers unlimited ways to test your skills at golf. Here are a few ways to make sure your score doesn’t get too high and your... | Read more »
Dark Hearts, The Sequel to Haunting Meli...
Dark Hearts, The Sequel to Haunting Melissa, is Available Now Posted by Jessica Fisher on November 21st, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Meowza! Toyze Brings Talking Tom to Life...
Meowza! | Read more »
Square Enix Announces New Tactical RPG f...
Square Enix Announces New Tactical RPG for Mobile, Heavenstrike Rivals. Posted by Jessica Fisher on November 21st, 2014 [ permalink ] With their epic stories and gorgeous graphics, | Read more »
Quest for Revenge (Games)
Quest for Revenge 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: The great Kingdom of the west has fallen. The gods ignore the prayers of the desperate. A dark warlord has extinguished... | Read more »
Threadz is a New Writing Adventure for Y...
Threadz is a New Writing Adventure for You and Your Friends Posted by Jessica Fisher on November 21st, 2014 [ permalink ] In the tradition of round-robin storytelling, | Read more »
SteelSeries Stratus XL Hardware Review
Made by: SteelSeries Price: $59.99 Hardware/iOS Integration Rating: 4 out of 5 stars Usability Rating: 4.5 out of 5 stars Reuse Value Rating: 4.25 out of 5 stars Build Quality Rating: 4.5 out of 5 stars Overall Rating: 4.31 out of 5 stars | Read more »
ACDSee (Photography)
ACDSee 1.0.0 Device: iOS iPhone Category: Photography Price: $1.99, Version: 1.0.0 (iTunes) Description: Capture, perfect, and share your photos with ACDSee. The ACDSee iPhone app combines an innovative camera, a powerful photo... | Read more »
ProTube for YouTube (Entertainment)
ProTube for YouTube 2.0.2 Device: iOS Universal Category: Entertainment Price: $1.99, Version: 2.0.2 (iTunes) Description: ProTube is the ultimate, fully featured YouTube app. With it's highly polished design, ProTube offers ad-free... | Read more »

Price Scanner via MacPrices.net

Save up to $400 with Apple refurbished 2014 1...
The Apple Store has restocked Apple Certified Refurbished 2014 15″ Retina MacBook Pros for up to $400 off the cost of new models. An Apple one-year warranty is included with each model, and shipping... Read more
New 13-inch 1.4GHz MacBook Air on sale for $8...
 Adorama has the 2014 13″ 1.4GHz/128GB MacBook Air on sale for $899.99 including free shipping plus NY & NJ tax only. Their price is $100 off MSRP. B&H Photo has the 13″ 1.4GHz/128GB MacBook... Read more
Apple Expected to Reverse Nine-Month Tablet S...
Apple and Samsung combined accounted for 62 percent of the nearly 36 million branded tablets shipped in 3Q 2014, according to early vendor shipment share estimates from market intelligence firm ABI... Read more
Stratos: 30 Percent of US Smartphone Owners t...
Stratos, Inc., creator of the Bluetooth Connected Card Platform, has announced results from its 2014 Holiday Mobile Payments Survey. The consumer survey found that nearly one out of three (30 percent... Read more
2014 1.4GHz Mac mini on sale for $449, save $...
 B&H Photo has lowered their price on the new 1.4GHz Mac mini to $449.99 including free shipping plus NY tax only. Their price is $50 off MSRP, and it’s the lowest price available for this new... Read more
Check Apple prices on any device with the iTr...
MacPrices is proud to offer readers a free iOS app (iPhones, iPads, & iPod touch) and Android app (Google Play and Amazon App Store) called iTracx, which allows you to glance at today’s lowest... Read more
64GB iPod touch on sale for $249, save $50
Best Buy has the 64GB iPod touch on sale for $249 on their online store for a limited time. Their price is $50 off MSRP. Choose free shipping or free local store pickup (if available). Sale price for... Read more
15″ 2.2GHz Retina MacBook Pro on sale for $17...
 B&H Photo has the 2014 15″ 2.2GHz Retina MacBook Pro on sale for $1799.99 for a limited time. Shipping is free, and B&H charges NY sales tax only. B&H will also include free copies of... Read more
New Logitech AnyAngle Case/Stand Brings Flexi...
Logitec has announced the newest addition to its suite of tablet products — the Logitech AnyAngle. A protective case with an any-angle stand for iPad Air 2 and all iPad mini models, AnyAngle is the... Read more
Notebook PC Shipments Rise Year-Over-Year as...
According to preliminary results from the upcoming DisplaySearch Quarterly Mobile PC Shipment and Forecast Report, the global notebook PC market grew 10 percent year-over-year in Q3’14 to 49.4... Read more

Jobs Board

*Apple* Solutions Consultant (ASC)- Retail S...
**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, *Apple* Financial Services...
**Job Summary** Apple Financial Services (AFS) offers consumers, businesses and educational institutions ways to finance Apple purchases. We work with national and Read more
*Apple* Store Leader Program - College Gradu...
Job Description: Job Summary As an Apple Store Leader Program agent, you can continue your education as you major in the art of leadership at the Apple Store. You'll 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
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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.