AW_xkey.cxx

Go to the documentation of this file.

// =============================================================== //
//                                                                 //
//   File      : AW_xkey.cxx                                       //
//   Purpose   :                                                   //
//                                                                 //
//   Institute of Microbiology (Technical University Munich)       //
//   http://www.arb-home.de/                                       //
//                                                                 //
// =============================================================== //

#include "aw_keysym.hxx"
#include "aw_xkey.hxx"
#include "aw_msg.hxx"

#include <arbdbt.h>
#include <arb_defs.h>

#include <X11/Xlib.h>
#include <X11/keysym.h>
#include <X11/Xutil.h>

#ifndef aw_assert
#define aw_assert(bed) arb_assert(bed)
#endif

// for keysyms see /usr/include/X11/keysymdef.h


// each entry in awxkeymap_modfree generates 9 entries : 2*SHIFT, 2*ALT, 2*META, 2*CTRL, 1 unMODified
// see awModDef below
static awXKeymap_modfree awxkeymap_modfree[] = {
    { XK_Left,      "Left",     AW_KEY_LEFT },
    { XK_Right,     "Right",    AW_KEY_RIGHT },
    { XK_Up,        "Up",       AW_KEY_UP },
    { XK_Down,      "Down",     AW_KEY_DOWN },
    { XK_Home,      "Home",     AW_KEY_HOME },
    { XK_End,       "End",      AW_KEY_END },
    { XK_Page_Up,   "PageUp",   AW_KEY_PGUP },
    { XK_Page_Down, "PageDown", AW_KEY_PGDN },
    { XK_Delete,    "Delete",   AW_KEY_DELETE }, // was same as BackSpace in the past -- 2007/11/15

    { 0, NULp, AW_KEY_NONE },
};

// manual key defs
// keys where all (or most) modifiers don't work should go here
static awXKeymap awxkeymap[] = {
    // sun keypad ?
    { XK_Shift_R, XK_R10, "Shift-Left",  AW_KEYMODE_SHIFT, AW_KEY_LEFT,  NULp },
    { XK_Shift_R, XK_R12, "Shift-Right", AW_KEYMODE_SHIFT, AW_KEY_RIGHT, NULp },
    { XK_Shift_L, XK_R10, "Shift-Left",  AW_KEYMODE_SHIFT, AW_KEY_LEFT,  NULp },
    { XK_Shift_L, XK_R12, "Shift-Right", AW_KEYMODE_SHIFT, AW_KEY_RIGHT, NULp },
    { 0,          XK_R7,  "Home",        AW_KEYMODE_NONE,  AW_KEY_HOME,  NULp },
    { 0,          XK_R13, "End",         AW_KEYMODE_NONE,  AW_KEY_END,   NULp },

    // functions keys
    { 0, XK_F1,  NULp, AW_KEYMODE_NONE, AW_KEY_F1,  NULp },
    { 0, XK_F2,  NULp, AW_KEYMODE_NONE, AW_KEY_F2,  NULp },
    { 0, XK_F3,  NULp, AW_KEYMODE_NONE, AW_KEY_F3,  NULp },
    { 0, XK_F4,  NULp, AW_KEYMODE_NONE, AW_KEY_F4,  NULp },
    { 0, XK_F5,  NULp, AW_KEYMODE_NONE, AW_KEY_F5,  NULp },
    { 0, XK_F6,  NULp, AW_KEYMODE_NONE, AW_KEY_F6,  NULp },
    { 0, XK_F7,  NULp, AW_KEYMODE_NONE, AW_KEY_F7,  NULp },
    { 0, XK_F8,  NULp, AW_KEYMODE_NONE, AW_KEY_F8,  NULp },
    { 0, XK_F9,  NULp, AW_KEYMODE_NONE, AW_KEY_F9,  NULp },
    { 0, XK_F10, NULp, AW_KEYMODE_NONE, AW_KEY_F10, NULp },
    { 0, XK_F11, NULp, AW_KEYMODE_NONE, AW_KEY_F11, NULp },
    { 0, XK_F12, NULp, AW_KEYMODE_NONE, AW_KEY_F12, NULp },

    // other
    { 0, XK_BackSpace, "BackSpace", AW_KEYMODE_NONE, AW_KEY_BACKSPACE, NULp },
    { 0, XK_Help,      NULp,        AW_KEYMODE_NONE, AW_KEY_HELP,      NULp },
    { 0, XK_Escape,    NULp,        AW_KEYMODE_NONE, AW_KEY_ESCAPE,    NULp },
    { 0, XK_Return,    NULp,        AW_KEYMODE_NONE, AW_KEY_RETURN,    NULp },
    { 0, XK_Tab,       NULp,        AW_KEYMODE_NONE, AW_KEY_RETURN,    NULp }, // done to accept input-field-changes via TAB, also disables inserting tabs

    { 0, 0, (char*)1, AW_KEYMODE_NONE, AW_KEY_NONE, NULp }
};

struct awModDef {
    int         xmod;
    const char *xstr_prefix;
    AW_key_mod  awmod;
};

static awModDef moddef[] = {
    { XK_Shift_L,   "Shift",   AW_KEYMODE_SHIFT },
    { XK_Shift_R,   "Shift",   AW_KEYMODE_SHIFT },
    { XK_Meta_L,    "Meta",    AW_KEYMODE_ALT },     // handle Meta as Alt
    { XK_Meta_R,    "Meta",    AW_KEYMODE_ALT },
    { XK_Alt_L,     "Alt",     AW_KEYMODE_ALT },
    { XK_Alt_R,     "Alt",     AW_KEYMODE_ALT },
    { XK_Control_L, "Control", AW_KEYMODE_CONTROL },
    { XK_Control_R, "Control", AW_KEYMODE_CONTROL },
    { 0,            NULp,      AW_KEYMODE_NONE },   // "no modifier" (this is NO array terminator!)
};

const int FIXEDMOD = TERMINATED_ARRAY_ELEMS(awxkeymap);
const int MODFREE  = TERMINATED_ARRAY_ELEMS(awxkeymap_modfree);
const int MODS     = ARRAY_ELEMS(moddef);

static GB_HASH    *awxkeymap_string_2_key_hash;
static GB_NUMHASH *awxkeymap_xkey_2_key_hash;
static int         generatedKeymaps_count = -1;
static awXKeymap  *generatedKeymaps       = NULp;


const int MAPPED_KEYS = MODFREE*MODS+FIXEDMOD;

#if defined(ASSERTION_USED)
static int mappedKeys = 0;
#endif // ASSERTION_USED

static void map_awXKey(Display *display, const awXKeymap *awxk) {
    if (awxk->xstr) {
        KeySym modlist[2];
        int    modsize;

        modlist[0] = awxk->xmod;
        modsize    = modlist[0] ? 1 : 0;

        XRebindKeysym(display, awxk->xkey, modlist, modsize,
                      (unsigned char*)awxk->xstr, strlen(awxk->xstr));

        GBS_write_hash(awxkeymap_string_2_key_hash, awxk->xstr, (long)awxk);
    }
    GBS_write_numhash(awxkeymap_xkey_2_key_hash, awxk->xkey, (long)awxk);

#if defined(ASSERTION_USED)
    ++mappedKeys;
#endif // ASSERTION_USED
}

void aw_install_xkeys(Display *display) {
    int i;

    awxkeymap_string_2_key_hash = GBS_create_hash(MAPPED_KEYS, GB_MIND_CASE);
    awxkeymap_xkey_2_key_hash   = GBS_create_numhash(MAPPED_KEYS);

    // auto-generate all key/modifier combinations for keys in awxkeymap_modfree
    for (i=0; ; ++i) {
        if (!awxkeymap_modfree[i].xstr_suffix) break;
    }

    int modfree = i;

    aw_assert(!generatedKeymaps); // oops - called twice

    generatedKeymaps_count = modfree*MODS;
    ARB_calloc(generatedKeymaps, generatedKeymaps_count);

    for (i=0; i<modfree; ++i) {
        const awXKeymap_modfree *mf = awxkeymap_modfree+i;
        for (int j = 0; j<MODS; ++j) {
            awXKeymap *km = generatedKeymaps+i*MODS+j;
            awModDef  *md = moddef+j;

            km->xmod  = md->xmod;
            km->xkey  = mf->xkey;
            km->xstr  = md->xstr_prefix ? GBS_global_string_copy("%s-%s", md->xstr_prefix, mf->xstr_suffix) : mf->xstr_suffix;
            km->awmod = md->awmod;
            km->awkey = mf->awkey;
            km->awstr = NULp;

            map_awXKey(display, km);
        }
    }

    // add manually defined keys
    for (i=0; ; ++i) {
        if (awxkeymap[i].xstr == (char*)1) break;
        map_awXKey(display, awxkeymap+i);
    }

    aw_assert(mappedKeys == MAPPED_KEYS);
}

void aw_uninstall_xkeys() {
    for (int i = 0; i<generatedKeymaps_count; ++i) {
        awXKeymap& km = generatedKeymaps[i];
        int        j  = i%MODS;
        awModDef&  md = moddef[j];

        if (md.xstr_prefix) free((char*)km.xstr);
    }
    free(generatedKeymaps); generatedKeymaps = NULp;

    if (awxkeymap_xkey_2_key_hash)   { GBS_free_numhash(awxkeymap_xkey_2_key_hash);   awxkeymap_xkey_2_key_hash   = NULp; }
    if (awxkeymap_string_2_key_hash) { GBS_free_hash   (awxkeymap_string_2_key_hash); awxkeymap_string_2_key_hash = NULp; }
}

#if defined(DEBUG)
// #define DUMP_KEYEVENTS
#endif // DEBUG

const awXKeymap *aw_xkey_2_awkey(XKeyEvent *xkeyevent) {
    awXKeymap *result;
    static awXKeymap singlekey = { 0, 0, NULp, AW_KEYMODE_NONE, AW_KEY_NONE, NULp };
    bool numlockwason = false;

    if (xkeyevent->state & AW_KEYMODE_NUMLOCK) {    // numlock is active
        xkeyevent->state &= ~AW_KEYMODE_NUMLOCK;    // ignore NUMLOCK
        numlockwason      = true;
    }

    const int   BUFFERSIZE = 256;;
    static char buffer[BUFFERSIZE];
    KeySym      keysym;
    int         count      = XLookupString(xkeyevent, buffer, BUFFERSIZE, &keysym, NULp);
    buffer[count]          = 0;

    if (!buffer[0] && count) {
#if defined(DUMP_KEYEVENTS)
        printf("special case: Ctrl-Space\n");
#endif
        aw_assert(keysym == XK_space);
        buffer[0] = ' ';
    }

#if defined(DUMP_KEYEVENTS)
    printf("state=%u keycode=%u name='%s' ", xkeyevent->state, xkeyevent->keycode, buffer);
#endif // DUMP_KEYEVENTS

    if (keysym >= XK_space && keysym <= XK_asciitilde) {
        singlekey.awkey = AW_KEY_ASCII;
        singlekey.awmod = (AW_key_mod)(xkeyevent->state & (AW_KEYMODE_CONTROL|AW_KEYMODE_ALT));  // forward ctrl and alt state
        singlekey.awstr = buffer;
        aw_assert(buffer[0]);

        result = &singlekey;

        if (numlockwason && (xkeyevent->state & AW_KEYMODE_ALT)) {
            static bool warned = false;
            if (!warned) {
                aw_message("Warning: Accelerator keys only work if NUMLOCK is off!");
                warned = true;
            }
        }

#if defined(DUMP_KEYEVENTS)
        printf("AW_KEY_ASCII:");
#endif // DUMP_KEYEVENTS
    }
    else {
        long ptr;

        if (count && (ptr = GBS_read_hash(awxkeymap_string_2_key_hash, buffer))) {
            result    = (awXKeymap*)ptr;

#if defined(DUMP_KEYEVENTS)
            printf("_awxkeymap_string_2_key_hash['%s']=", buffer);
#endif // DUMP_KEYEVENTS
        }
        else if ((ptr = GBS_read_numhash(awxkeymap_xkey_2_key_hash, keysym))) {
            result    = (awXKeymap*)ptr;

#if defined(DUMP_KEYEVENTS)
            printf("_awxkeymap_xkey_2_key_hash['%x']='%s'", (unsigned)keysym, result->xstr);
#endif // DUMP_KEYEVENTS
        }
        else {
            singlekey.awkey = AW_KEY_NONE;
            singlekey.awmod = AW_KEYMODE_NONE;
            singlekey.awstr = NULp;

            result = &singlekey;

#if defined(DUMP_KEYEVENTS)
            printf("Undefined key (keysym=%x)", (unsigned)keysym);
            if (count) printf(" name='%s'", buffer);
#endif // DUMP_KEYEVENTS
        }
    }
#if defined(DUMP_KEYEVENTS)
    printf(" key='%u' mod='%u' awstr='%s'\n", result->awkey, result->awmod, result->awstr);
#endif // DUMP_KEYEVENTS

    return result;
}