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
$524.94
Apple Inc.
+5.93
MSFT
$40.01
Microsoft Corpora
-0.39
GOOG
$536.10
Google Inc.
-20.44

MacTech Search:
Community Search:

Software Updates via MacUpdate

VMware Fusion 6.0.3 - Run Windows apps a...
VMware Fusion allows you to create a Virtual Machine on your Mac and run Windows (including Windows 8.1) and Windows software on your Mac. Run your favorite Windows applications alongside Mac... Read more
Tweetbot 1.5.1 - Popular iOS twitter cli...
Tweetbot is a full-featured OS X Twitter client with a lot of personality. Whether it's the meticulously-crafted interface, sounds and animation, or features like multiple timelines and column views... Read more
Mac DVDRipper Pro 4.1.7 - Copy, backup,...
Mac DVDRipper Pro is the DVD backup solution that lets you protect your DVDs from scratches, save your batteries by reading your movies from your hard disk, manage your collection with just a few... Read more
PDFpenPro 6.2 - Advanced PDF toolkit for...
PDFpenPro allows users to edit PDF's easily. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Even correct text and edit graphics! Create... Read more
PDFpen 6.2 - Edit and annotate PDFs with...
PDFpen allows users to easily edit PDF's. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Even correct text and edit graphics! Features... Read more
Monolingual 1.5.9 - Remove unwanted OS X...
Monolingual is a program for removing unnecesary language resources from OS X, in order to reclaim several hundred megabytes of disk space. It requires a 64-bit capable Intel-based Mac and at least... 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
Starcraft II: Wings of Liberty 1.1.1.180...
Download the patch by launching the Starcraft II game and downloading it through the Battle.net connection within the app. Starcraft II: Wings of Liberty is a strategy game played in real-time. You... Read more
Sibelius 7.5.0 - Music notation solution...
Sibelius is the world's best-selling music notation software for Mac. It is as intuitive to use as a pen, yet so powerful that it does most things in less than the blink of an eye. The demo includes... Read more
Typinator 5.9 - Speedy and reliable text...
Typinator turbo-charges your typing productivity. Type a little. Typinator does the rest. We've all faced projects that require repetitive typing tasks. With Typinator, you can store commonly used... Read more

Latest Forum Discussions

See All

Have a Special Dead Trigger 2 Easter Bas...
Have a Special Dead Trigger 2 Easter Basket Full of Goodies, Courtesy of Madfinger Games Posted by Rob Rich on April 18th, 2014 [ permalink ] Dead Trigger 2 | Read more »
Almost All of Playdek’s Library is on Sa...
Almost All of Playdek’s Library is on Sale Right Now, and You Should Check it Out Posted by Rob Rich on April 18th, 2014 [ permalink ] Playdek has released quite a few great iOS ports of board and card games over the years, and now most of them... | Read more »
Zynga Launches Brand New Farmville Exper...
Zynga Launches Brand New Farmville Experience with Farmville 2: Country Escape Posted by Tre Lawrence on April 18th, 2014 [ permalink ] | Read more »
David. Review
David. Review By Cata Modorcea on April 18th, 2014 Our Rating: :: MINIMALISTIC IN A DIFFERENT WAYUniversal App - Designed for iPhone and iPad David is a minimalistic game wrapped inside of a soothing atmosphere in which the hero... | Read more »
Eyefi Unveils New Eyefi Cloud Service Th...
Eyefi Unveils New Eyefi Cloud Service That Allows Users to Share Media Across Personal Devices Posted by Tre Lawrence on April 18th, 2014 [ permalink ] | Read more »
Tales from the Dragon Mountain: The Lair...
Tales from the Dragon Mountain: The Lair Review By Jennifer Allen on April 18th, 2014 Our Rating: :: STEADY ADVENTURINGiPad Only App - Designed for the iPad Treading a safe path, Tales from the Dragon Mountain: The Lair is a... | Read more »
Yahoo Updates Flickr App with Advanced E...
Yahoo Updates Flickr App with Advanced Editing Features and More Posted by Tre Lawrence on April 18th, 2014 [ permalink ] | Read more »
My Incredible Body - A Kid's App to...
My Incredible Body - A Kid's App to Learn about the Human Body 1.1.00 Device: iOS Universal Category: Education Price: $2.99, Version: 1.1.00 (iTunes) Description: Wouldn’t it be cool to look inside yourself and see what was going on... | Read more »
Trials Frontier Review
Trials Frontier Review By Carter Dotson on April 18th, 2014 Our Rating: :: A ROUGH LANDINGUniversal App - Designed for iPhone and iPad Trials Frontier finally brings the famed stunt racing franchise to mobile, but how much does its... | Read more »
Evernote Business Notebook by Moleskin I...
Evernote Business Notebook by Moleskin Introduced – Support Available in Evernote for iOS Posted by Tre Lawrence on April 18th, 2014 [ permalink ] | Read more »

Price Scanner via MacPrices.net

Deal Alert! 13-inch MacBook Pro on sale for $...
Best Buy has the 13″ 2.5GHz MacBook Pro on sale for $999.99 on their online store. Choose free shipping or free instant local store pickup (if available). Their price is $200 off MSRP. Price is valid... Read more
Free HopTo 2.2 Helps Enhance Your Productivit...
The HopTo app helps you do more on your iPad by providing more and easier adaccess to files and documents. Version 2.2 adds Egnyte and HopTo’s Mac OSX File Connector. If you already have the hopTo... Read more
National Distracted Driving Awareness Month:...
As the country recognizes National Distracted Driving Awareness Month, Sprint is reminding wireless consumers to focus on driving while behind the wheel, to not text or email while driving, and to... Read more
13-inch 2.4GHz Retina MacBook Pro available f...
Abt has the 13″ 2.4GHz 128GB Retina MacBook Pro available for $1229 including free shipping. Their price is $70 off MSRP. Read more
iMacs on sale for up to $160 off MSRP this we...
Best Buy has iMacs on sale for up to $160 off MSRP for a limited time. Choose free home shipping or free instant local store pickup (if available). Prices are valid for online orders only, in-store... Read more
iPad Airs on sale this weekend for up to $100...
Best Buy has WiFi iPad Airs on sale for $50 off MSRP and WiFi + Cellular iPad Airs on sale for $100 off MSRP on their online store for a limited time, with prices now starting at $449. Choose free... Read more
Apple restocks refurbished Mac minis starting...
The Apple Store has restocked Apple Certified Refurbished Mac minis for up to $150 off the cost of new models. Apple’s one-year warranty is included with each mini, and shipping is free: - 2.5GHz Mac... Read more
Hyundai Brings Apple CarPlay To The 2015 Sona...
Hyundai Motor America has announced it will bring Apple CarPlay functionality to the 2015 Sonata. CarPlay is pitched as a smarter, safer and easier way to use iPhone in the car and gives iPhone users... Read more
Updated iPads Coming Sooner Than We Had Thoug...
MacRumors, cites KGI securities analyst Ming Chi Kuo, well-respected as an Apple product prognisticator, saying that Apple will introduce an upgraded iPad Air and iPad mini in 2014/Q3, meaning the... Read more
Toshiba Unveils New High And Low End Laptop M...
Toshiba has announced new laptop models covering both the high-end and low-end of the notebook computer spectrum. Toshiba 4K Ultra HD Laptop Toshiba’s new Satellite P55t features one of the world’s... Read more

Jobs Board

*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* Inc. Research Data Specialist - Appl...
…of Worldwide Market Research & Intelligence. The team is responsible for conducting Apple branded consumer market research. It is also responsible for analyzing data Read more
*Apple* Automotive Parts Department position...
Apple Automotive is one of the fastest growing dealer…and it shows. Consider making the switch to the Apple Automotive Group today! At Apple Automotive, we 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* Retail - Manager - Holyoke - Apple I...
Job Summary Keeping an Apple Store thriving requires a diverse set of leadership skills, and as a Manager, you’re a master of them all. In the store’s fast-paced, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.