Polish "programmer's keyboard"

[WojciechGw]

I've wrote some code for Polish "programmer's keyboard" for US_UK keyboards
Maybe someone will find it usefull.

polish letters :
ąćęłńóśżź respectively AltGr+acelnozx
ĄĆĘŁŃÓŚŻŹ respectively Shift+AltGr+acelnoszx

Caps Lock state is respected.

Whole thing demands some changes to source
in main CMakeLists.txt,
rp6502/ria/usb kbd.c,
new file with keyboard definition kbd_pol.h
and set 852 code page with command
SET CP 852

main CMakeLists.txt

set_property(TARGET rp6502_ria rp6502_vga
    APPEND PROPERTY COMPILE_DEFINITIONS
    RP6502_NAME="Picocomputer 6502"
    RP6502_VERSION="PLPRGKBD"
    RP6502_CODE_PAGE=0
    RP6502_KEYBOARD=PL
    RP6502_MIN_PHI2=500
    RP6502_MAX_PHI2=8000
    RP6502_EXFAT=0
)

new file kbd_pol.h

/*
 * Copyright (c) 2023 Rumbledethumps
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

/* 
 * Polish programmer's keyboard / polska klawiatura programisty
 * by WojciechGw
 */

#ifndef _KBD_POL_H_
#define _KBD_POL_H_


// KEYCODE to Unicode Conversion
// {without shift, with shift, with altGr}

#define HID_KEYCODE_TO_UNICODE_PL         HID_KEYCODE_TO_UNICODE_POL_QWERTY
#define HID_KEYCODE_TO_UNICODE_PL_QWERTY  HID_KEYCODE_TO_UNICODE_POL_QWERTY
#define HID_KEYCODE_TO_UNICODE_POL        HID_KEYCODE_TO_UNICODE_POL_QWERTY

/*
Ą – 0x0104; ą – 0x0105
Ć - 0x0106; ć – 0x0107
Ę - 0x0118; ę – 0x0119
Ł - 0x0141; ł – 0x0142
Ń - 0x0143; ń – 0x0144
Ó - 0x00d3; ó – 0x00f3
Ś - 0x015a; ś – 0x015b
Ź - 0x0179; ź – 0x017a
Ż - 0x017b; ż – 0x017c
*/

#define PL_O_ACCENTED 0x00d3 // Ó
#define PL_o_ACCENTED 0x00f3 // ó

#define HID_KEYCODE_TO_UNICODE_POL_QWERTY \
        /* 0x00 */ {0, 0, 0},            \
        /* 0x01 */ {0, 0, 0},            \
        /* 0x02 */ {0, 0, 0},            \
        /* 0x03 */ {0, 0, 0},            \
        /* ąĄ 0x04 */ {'a', 'A', 0x0105},\
        /* 0x05 */ {'b', 'B', 0},        \
        /* ćĆ 0x06 */ {'c', 'C', 0x0107},\
        /* 0x07 */ {'d', 'D', 0},        \
        /* ęĘ 0x08 */ {'e', 'E', 0x0119},\
        /* 0x09 */ {'f', 'F', 0},        \
        /* 0x0a */ {'g', 'G', 0},        \
        /* 0x0b */ {'h', 'H', 0},        \
        /* 0x0c */ {'i', 'I', 0},        \
        /* 0x0d */ {'j', 'J', 0},        \
        /* 0x0e */ {'k', 'K', 0},        \
        /* łŁ 0x0f */ {'l', 'L', 0x0142},\
        /* 0x10 */ {'m', 'M', 0},        \
        /* ńŃ 0x11 */ {'n', 'N', 0x0144},\
        /* óÓ 0x12 */ {'o', 'O', 0x00f3},\
        /* 0x13 */ {'p', 'P', 0},        \
        /* 0x14 */ {'q', 'Q', 0},        \
        /* 0x15 */ {'r', 'R', 0}, \
        /* śŚ 0x16 */ {'s', 'S', 0x015b},\
        /* 0x17 */ {'t', 'T', 0},        \
        /* 0x18 */ {'u', 'U', 0},        \
        /* 0x19 */ {'v', 'V', 0},        \
        /* 0x1a */ {'w', 'W', 0},        \
        /* źŹ 0x1b */ {'x', 'X', 0x017a},\
        /* 0x1c */ {'y', 'Y', 0},        \
        /* żŻ 0x1d */ {'z', 'Z', 0x017c},\
        /* 0x1e */ {'1', '!', 0},        \
        /* 0x1f */ {'2', '@', 0},        \
        /* § 0x20 */ {'3', '#', 0x00a7}, \
        /* 0x21 */ {'4', '$', 0}, \
        /* 0x22 */ {'5', '%', 0},        \
        /* 0x23 */ {'6', '^', 0},        \
        /* 0x24 */ {'7', '&', 0},        \
        /* 0x25 */ {'8', '*', 0},        \
        /* 0x26 */ {'9', '(', 0},        \
        /* 0x27 */ {'0', ')', 0},        \
        /* 0x28 */ {'\r', '\r', 0},      \
        /* 0x29 */ {'\x1b', '\x1b', 0},  \
        /* 0x2a */ {'\x7f', '\x7f', 0},  \
        /* 0x2b */ {'\t', '\t', 0},      \
        /* 0x2c */ {' ', ' ', 0},        \
        /* 0x2d */ {'-', '_', 0},        \
        /* 0x2e */ {'=', '+', 0},        \
        /* 0x2f */ {'[', '{', 0},        \
        /* 0x30 */ {']', '}', 0},        \
        /* 0x31 */ {'\\', '|', 0},       \
        /* 0x32 */ {'\\', '|', 0},       \
        /* 0x33 */ {';', ':', 0},        \
        /* 0x34 */ {'\'', '\"', 0},      \
        /* ° 0x35 */ {'`', '~', 0x00b0}, \
        /* 0x36 */ {',', '<', 0},        \
        /* 0x37 */ {'.', '>', 0},        \
        /* 0x38 */ {'/', '?', 0},        \
        /* 0x39 */ {0, 0, 0},            \
        /* 0x3a */ {0, 0, 0},            \
        /* 0x3b */ {0, 0, 0},            \
        /* 0x3c */ {0, 0, 0},            \
        /* 0x3d */ {0, 0, 0},            \
        /* 0x3e */ {0, 0, 0},            \
        /* 0x3f */ {0, 0, 0},            \
        /* 0x40 */ {0, 0, 0},            \
        /* 0x41 */ {0, 0, 0},            \
        /* 0x42 */ {0, 0, 0},            \
        /* 0x43 */ {0, 0, 0},            \
        /* 0x44 */ {0, 0, 0},            \
        /* 0x45 */ {0, 0, 0},            \
        /* 0x46 */ {0, 0, 0},            \
        /* 0x47 */ {0, 0, 0},            \
        /* 0x48 */ {0, 0, 0},            \
        /* 0x49 */ {0, 0, 0},            \
        /* 0x4a */ {0, 0, 0},            \
        /* 0x4b */ {0, 0, 0},            \
        /* 0x4c */ {0, 0, 0},            \
        /* 0x4d */ {0, 0, 0},            \
        /* 0x4e */ {0, 0, 0},            \
        /* 0x4f */ {0, 0, 0},            \
        /* 0x50 */ {0, 0, 0},            \
        /* 0x51 */ {0, 0, 0},            \
        /* 0x52 */ {0, 0, 0},            \
        /* 0x53 */ {0, 0, 0},            \
        /* 0x54 */ {'/', '/', 0},        \
        /* 0x55 */ {'*', '*', 0},        \
        /* 0x56 */ {'-', '-', 0},        \
        /* 0x57 */ {'+', '+', 0},        \
        /* 0x58 */ {'\r', '\r', 0},      \
        /* 0x59 */ {'1', 0, 0},          \
        /* 0x5a */ {'2', 0, 0},          \
        /* 0x5b */ {'3', 0, 0},          \
        /* 0x5c */ {'4', 0, 0},          \
        /* 0x5d */ {'5', 0, 0},          \
        /* 0x5e */ {'6', 0, 0},          \
        /* 0x5f */ {'7', 0, 0},          \
        /* 0x60 */ {'8', 0, 0},          \
        /* 0x61 */ {'9', 0, 0},          \
        /* 0x62 */ {'0', 0, 0},          \
        /* 0x63 */ {'.', 0, 0},          \
        /* 0x64 */ {'\\', '|', 0},       \
        /* 0x65 */ {0, 0, 0},            \
        /* 0x66 */ {0, 0, 0},            \
        /* 0x67 */ {'=', '=', 0},        \
        /* 0x68 */ {0, 0, 0},            \
        /* 0x69 */ {0, 0, 0},            \
        /* 0x6a */ {0, 0, 0},            \
        /* 0x6b */ {0, 0, 0},            \
        /* 0x6c */ {0, 0, 0},            \
        /* 0x6d */ {0, 0, 0},            \
        /* 0x6e */ {0, 0, 0},            \
        /* 0x6f */ {0, 0, 0},            \
        /* 0x70 */ {0, 0, 0},            \
        /* 0x71 */ {0, 0, 0},            \
        /* 0x72 */ {0, 0, 0},            \
        /* 0x73 */ {0, 0, 0},            \
        /* 0x74 */ {0, 0, 0},            \
        /* 0x75 */ {0, 0, 0},            \
        /* 0x76 */ {0, 0, 0},            \
        /* 0x77 */ {0, 0, 0},            \
        /* 0x78 */ {0, 0, 0},            \
        /* 0x79 */ {0, 0, 0},            \
        /* 0x7a */ {0, 0, 0},            \
        /* 0x7b */ {0, 0, 0},            \
        /* 0x7c */ {0, 0, 0},            \
        /* 0x7d */ {0, 0, 0},            \
        /* 0x7e */ {0, 0, 0},            \
        /* 0x7f */ {0, 0, 0},

#endif /* _KBD_POL_H_ */

kbd.c additional code

#include "usb/kbd_pol.h"

static void kbd_queue_key(uint8_t modifier, uint8_t keycode, bool initial_press)
{

[...]

    // Find plain typed or AltGr character
    char ch = 0;
    if (keycode < 128 && !((modifier & (KEYBOARD_MODIFIER_LEFTALT |
                                        KEYBOARD_MODIFIER_LEFTGUI |
                                        KEYBOARD_MODIFIER_RIGHTGUI))))
    {
        if (modifier & KEYBOARD_MODIFIER_RIGHTALT)
            ch = ff_uni2oem(KEYCODE_TO_UNICODE[keycode][2], cfg_get_codepage());
        else if ((key_shift && !is_capslock) ||
                 (key_shift && keycode > HID_KEY_Z) ||
                 (!key_shift && is_capslock && keycode <= HID_KEY_Z))
            ch = ff_uni2oem(KEYCODE_TO_UNICODE[keycode][1], cfg_get_codepage());
        else
            ch = ff_uni2oem(KEYCODE_TO_UNICODE[keycode][0], cfg_get_codepage());

        // for Polish "programmer's" keyboard
        // or other ones demanding 4th state (SHIFT+ALTGR) definitions in KEYCODE_TO_UNICODE table
        if ((key_shift && key_alt && !is_capslock) || (!key_shift && key_alt && is_capslock))
        {
            ch = ff_uni2oem(KEYCODE_TO_UNICODE[keycode][2]-1, cfg_get_codepage());
            if(KEYCODE_TO_UNICODE[keycode][2] == PL_o_ACCENTED)
                ch = ff_uni2oem(PL_O_ACCENTED , cfg_get_codepage());
        } 
    }
    // ALT characters not found in AltGr get escaped

[rumbledethumps]

If you want to do the work to add a fourth column to all the key maps and make a pull request, this can be merged. Pretty sure I saw other keyboards needing shift-altgr. The PL_O_ACCENTED exception is just a bit too gnarly to maintain.

Still need dead keys support too. Feeling ambitious?

[WojciechGw]

:) agree about PL_O_ACCENTED exception

I just took advantage of the fact that all Polish uppercase letters have their codes reduced by one
from the corresponding lowercase letters.
Except for PL_O_ACCENTED (Óó) unfortunately ... hence such and not another code in kbd_queue_key function.

Yes, I want to do the work with 4th column and think about dead keys too. It will makes "kbd" life much easier.

It's not a matter of ambition, I just fell in love with your design :)