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
; 
 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Persecond 1.0.9 - Timelapse video made e...
Persecond is the easy, fun way to create a beautiful timelapse video. Import an image sequence from any camera, trim the length of your video, adjust the speed and playback direction, and you’re done... Read more
CrossOver 16.2 - Run Windows apps on you...
CrossOver can get your Windows productivity applications and PC games up and running on your Mac quickly and easily. CrossOver runs the Windows software that you need on Mac at home, in the office,... Read more
MegaSeg 6.0.2 - Professional DJ and radi...
MegaSeg is a complete solution for pro audio/video DJ mixing, radio automation, and music scheduling with rock-solid performance and an easy-to-use design. Mix with visual waveforms and Magic... Read more
Apple iTunes 12.6 - Play Apple Music and...
Apple iTunes lets you organize and stream Apple Music, download and watch video and listen to Podcasts. It can automatically download new music, app, and book purchases across all your devices and... Read more
GraphicConverter 10.4 - $39.95
GraphicConverter is an all-purpose image-editing program that can import 200 different graphic-based formats, edit the image, and export it to any of 80 available file formats. The high-end editing... Read more
OpenEmu 2.0.5 - Open Source game-emulati...
OpenEmu is about to change the world of video game emulation, one console at a time... For the first time, the 'It just works' philosophy now extends to open source video game emulation on the Mac.... Read more
beaTunes 4.6.13 - Organize your music co...
beaTunes is a full-featured music player and organizational tool for music collections. How well organized is your music library? Are your artists always spelled the same way? Any R.E.M. vs REM?... Read more
Vienna 3.1.9 :e81515b: - RSS and Atom ne...
Vienna is a freeware and Open-Source RSS/Atom newsreader with article storage and management via a SQLite database, written in Objective-C and Cocoa, for the OS X operating system. It provides... Read more
Safari Technology Preview 10.2 - The new...
Safari Technology Preview contains the most recent additions and improvements to WebKit and the latest advances in Safari web technologies. And once installed, you will receive notifications of... Read more
Cocktail 10.3.1 - General maintenance an...
Cocktail is a general purpose utility for macOS that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more

The Elder Scrolls: Legends is now availa...
| Read more »
Ticket to Earth beginner's guide: H...
Robot Circus launched Ticket to Earth as part of the App Store's indie games event last week. If you're not quite digging the space operatics Mass Effect: Andromeda is serving up, you'll be pleased to know that there's a surprising alternative on... | Read more »
Leap to victory in Nexx Studios new plat...
You’re always a hop, skip, and a jump away from a fiery death in Temple Jump, a new platformer-cum-endless runner from Nexx Studio. It’s out now on both iOS and Android if you’re an adventurer seeking treasure in a crumbling, pixel-laden temple. | Read more »
Failbetter Games details changes coming...
Sunless Sea, Failbetter Games' dark and gloomy sea explorer, sets sail for the iPad tomorrow. Ahead of the game's launch, Failbetter took to Twitter to discuss what will be different in the mobile version of the game. Many of the changes make... | Read more »
Splish, splash! The Pokémon GO Water Fes...
Niantic is back with a new festival for dedicated Pokémon GO collectors. The Water Festival officially kicks off today at 1 P.M. PDT and runs through March 29. Magikarp, Squirtle, Totodile, and their assorted evolved forms will be appearing at... | Read more »
Death Road to Canada (Games)
Death Road to Canada 1.0 Device: iOS Universal Category: Games Price: $7.99, Version: 1.0 (iTunes) Description: Get it now at the low launch price! Price will go up a dollar every major update. Update news at the bottom of this... | Read more »
Bean's Quest Beginner's Guide:...
Bean's Quest is a new take on both the classic platformer and the endless runner, and it's free on the App Store for the time being. Instead of running constantly, you can't stop jumping. That adds a surprising new level of challenge to the game... | Read more »
How to rake in the cash in Bit City
Our last Bit City guide covered the basics. Now it's time to get into some of the more advanced techniques. In the later cities, cash flow becomes much more difficult, so you'll want to develop some strategies if you want to complete each level.... | Read more »
PixelTerra (Games)
PixelTerra 1.1.1 Device: iOS Universal Category: Games Price: $.99, Version: 1.1.1 (iTunes) Description: The world of PixelTerra is quite dangerous so you need to build a shelter, find some food supply and get ready to protect... | Read more »
Tokaido™ (Games)
Tokaido™ 1.0 Device: iOS Universal Category: Games Price: $6.99, Version: 1.0 (iTunes) Description: Discover the digital adaptation of Tokaido, the boardgame phenomenon that has already sold more than 250,000 copies worldwide, and... | Read more »

Price Scanner via MacPrices.net

Apple’s iPhone 6s Tops Best-Selling Smartphon...
In terms of shipments, the iPhone 6s from Apple bested all competitors for sales in 2016, according to new analysis from IHS Markit, a world leader in critical information, analytics and solutions.... Read more
Logitech Rugged Combo Protective iPad Case an...
Logitech has announced its Logitech Rugged Combo, Logitech Rugged Case, and Logitech Add-on Keyboard for Rugged Case for Apple’s new, more affordable $329 9.7-inch iPad, a complete solution designed... Read more
T-Mobile To Offer iPhone 7 and iPhone 7 Plus...
T-Mobile has announced it will offer iPhone 7 and iPhone 7 Plus (PRODUCT)RED Special Edition in a vibrant red aluminum finish. The introduction of this special edition iPhone celebrates Apple’s 10... Read more
9-inch 128GB iPad Pros on sale for $50-$70 of...
B&H Photo has 9.7″ 128GB Apple WiFi iPad Pros on sale for up to $70 off MSRP, each including free shipping. B&H charges sales tax in NY only: - 9″ Space Gray 128GB WiFi iPad Pro: $649 $50... Read more
27-inch iMacs on sale for up to $200 off MSRP...
B&H Photo has 27″ Apple iMacs on sale for up to $200 off MSRP, each including free shipping plus NY sales tax only: - 27″ 3.3GHz iMac 5K: $2099 $200 off MSRP - 27″ 3.2GHz/1TB Fusion iMac 5K: $... Read more
Save up to $600 with Apple refurbished Mac Pr...
Apple has Certified Refurbished Mac Pros available for up to $600 off the cost of new models. An Apple one-year warranty is included with each Mac Pro, and shipping is free. The following... Read more
Save $230 with Apple Certified Refurbished 13...
Apple is now offering Certified Refurbished 2016 13″ 2.0GHz non-Touch Bar MacBook Pros for $230 off original MSRP. An Apple one-year warranty is included with each model, and shipping is free: - 13″... Read more
Apple price trackers, updated continuously
Scan our Apple Price Trackers for the latest information on sales, bundles, and availability on systems from Apple’s authorized internet/catalog resellers. We update the trackers continuously: - 15″... Read more
13-inch Touch Bar MacBook Pros on sale for up...
B&H Photo has the Apple 13″ Touch Bar MacBook Pros in stock today and on sale for up to $150 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.9GHz/512GB Touch Bar... Read more
Today only! 15-inch 2.7GHz Space Gray Touch B...
B&H Photo has the new 2016 15″ 2.7GHz Space Gray Apple Touch Bar MacBook Pro in stock today and on sale for $300 off MSRP for today only. Shipping is free, and B&H charges NY sales tax only... Read more

Jobs Board

*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Director, *Apple* Program - ERP & Cloud...
Leading Pharmaceutical / Biotech Company is announcing a Director, Apple Program - ERP & Cloud Platform Architecture Lead opportunity in Northbrook, IL. Purpose & 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
Starte Dein Karriere-Abenteuer in den Hauptst...
…mehrsprachigen Teams betreust Du Kunden von bekannten globale Marken wie Apple , Mercedes, Facebook, Expedia, und vielen anderen! Funktion Du wolltest schon Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.