xkbAccessX.c 27.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/************************************************************
Copyright (c) 1993 by Silicon Graphics Computer Systems, Inc.

Permission to use, copy, modify, and distribute this
software and its documentation for any purpose and without
fee is hereby granted, provided that the above copyright
notice appear in all copies and that both that copyright
notice and this permission notice appear in supporting
documentation, and that the name of Silicon Graphics not be 
used in advertising or publicity pertaining to distribution 
of the software without specific prior written permission.
Silicon Graphics makes no representation about the suitability 
of this software for any purpose. It is provided "as is"
without any express or implied warranty.

SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS 
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 
AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL 
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, 
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION  WITH
THE USE OR PERFORMANCE OF THIS SOFTWARE.

********************************************************/

27 28 29 30
#ifdef HAVE_DIX_CONFIG_H
#include <dix-config.h>
#endif

31 32 33 34 35
#include <stdio.h>
#include <math.h>
#include <X11/X.h>
#include <X11/Xproto.h>
#include <X11/keysym.h>
36 37
#include "exglobals.h"
#include <X11/extensions/XIproto.h>
38
#include "inputstr.h"
39
#include "eventstr.h"
40
#include "inpututils.h"
41
#include <xkbsrv.h>
Mathieu Bérard's avatar
Mathieu Bérard committed
42
#if !defined(WIN32)
43 44 45
#include <sys/time.h>
#endif

46 47
int XkbDfltRepeatDelay = 660;
int XkbDfltRepeatInterval = 40;
48 49 50 51

#define	DFLT_TIMEOUT_CTRLS (XkbAX_KRGMask|XkbStickyKeysMask|XkbMouseKeysMask)
#define	DFLT_TIMEOUT_OPTS  (XkbAX_IndicatorFBMask)

52 53 54 55 56 57 58 59 60
unsigned short XkbDfltAccessXTimeout = 120;
unsigned int XkbDfltAccessXTimeoutMask = DFLT_TIMEOUT_CTRLS;
static unsigned int XkbDfltAccessXTimeoutValues = 0;
static unsigned int XkbDfltAccessXTimeoutOptionsMask = DFLT_TIMEOUT_OPTS;
static unsigned int XkbDfltAccessXTimeoutOptionsValues = 0;
unsigned int XkbDfltAccessXFeedback = XkbAccessXFeedbackMask;
unsigned short XkbDfltAccessXOptions =
    XkbAX_AllOptionsMask & ~(XkbAX_IndicatorFBMask | XkbAX_SKReleaseFBMask |
                             XkbAX_SKRejectFBMask);
61

62
void
63
AccessXComputeCurveFactor(XkbSrvInfoPtr xkbi, XkbControlsPtr ctrls)
64
{
65 66 67 68
    xkbi->mouseKeysCurve = 1.0 + (((double) ctrls->mk_curve) * 0.001);
    xkbi->mouseKeysCurveFactor = (((double) ctrls->mk_max_speed) /
                                  pow((double) ctrls->mk_time_to_max,
                                      xkbi->mouseKeysCurve));
69 70 71
    return;
}

72
void
73 74
AccessXInit(DeviceIntPtr keybd)
{
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
    XkbSrvInfoPtr xkbi = keybd->key->xkbInfo;
    XkbControlsPtr ctrls = xkbi->desc->ctrls;

    xkbi->shiftKeyCount = 0;
    xkbi->mouseKeysCounter = 0;
    xkbi->inactiveKey = 0;
    xkbi->slowKey = 0;
    xkbi->repeatKey = 0;
    xkbi->krgTimerActive = _OFF_TIMER;
    xkbi->beepType = _BEEP_NONE;
    xkbi->beepCount = 0;
    xkbi->mouseKeyTimer = NULL;
    xkbi->slowKeysTimer = NULL;
    xkbi->bounceKeysTimer = NULL;
    xkbi->repeatKeyTimer = NULL;
    xkbi->krgTimer = NULL;
    xkbi->beepTimer = NULL;
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
    ctrls->repeat_delay = XkbDfltRepeatDelay;
    ctrls->repeat_interval = XkbDfltRepeatInterval;
    ctrls->debounce_delay = 300;
    ctrls->slow_keys_delay = 300;
    ctrls->mk_delay = 160;
    ctrls->mk_interval = 40;
    ctrls->mk_time_to_max = 30;
    ctrls->mk_max_speed = 30;
    ctrls->mk_curve = 500;
    ctrls->mk_dflt_btn = 1;
    ctrls->ax_timeout = XkbDfltAccessXTimeout;
    ctrls->axt_ctrls_mask = XkbDfltAccessXTimeoutMask;
    ctrls->axt_ctrls_values = XkbDfltAccessXTimeoutValues;
    ctrls->axt_opts_mask = XkbDfltAccessXTimeoutOptionsMask;
    ctrls->axt_opts_values = XkbDfltAccessXTimeoutOptionsValues;
    if (XkbDfltAccessXTimeout)
108
        ctrls->enabled_ctrls |= XkbAccessXTimeoutMask;
109
    else
110
        ctrls->enabled_ctrls &= ~XkbAccessXTimeoutMask;
111
    ctrls->enabled_ctrls |= XkbDfltAccessXFeedback;
112 113
    ctrls->ax_options = XkbDfltAccessXOptions;
    AccessXComputeCurveFactor(xkbi, ctrls);
114 115 116 117 118 119 120 121 122 123
    return;
}

/************************************************************************/
/*									*/
/* AccessXKeyboardEvent							*/
/*									*/
/*	Generate a synthetic keyboard event.				*/
/*									*/
/************************************************************************/
124 125
static void
AccessXKeyboardEvent(DeviceIntPtr keybd, int type, BYTE keyCode, Bool isRepeat)
126
{
127
    DeviceEvent event;
128 129

    init_device_event(&event, keybd, GetTimeInMillis());
130 131
    event.type = type;
    event.detail.key = keyCode;
132
    event.key_repeat = isRepeat;
133

134 135
    if (xkbDebugFlags & 0x8) {
        DebugF("[xkb] AXKE: Key %d %s\n", keyCode,
136
               (event.type == ET_KeyPress ? "down" : "up"));
137 138
    }

139
    XkbProcessKeyboardEvent(&event, keybd);
140
    return;
141
}                               /* AccessXKeyboardEvent */
142 143 144 145 146 147 148 149 150

/************************************************************************/
/*									*/
/* AccessXKRGTurnOn							*/
/*									*/
/*	Turn the keyboard response group on.				*/
/*									*/
/************************************************************************/
static void
151
AccessXKRGTurnOn(DeviceIntPtr dev, CARD16 KRGControl, xkbControlsNotify * pCN)
152
{
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
    XkbSrvInfoPtr xkbi = dev->key->xkbInfo;
    XkbControlsPtr ctrls = xkbi->desc->ctrls;
    XkbControlsRec old;
    XkbEventCauseRec cause;
    XkbSrvLedInfoPtr sli;

    old = *ctrls;
    ctrls->enabled_ctrls |= (KRGControl & XkbAX_KRGMask);
    if (XkbComputeControlsNotify(dev, &old, ctrls, pCN, FALSE))
        XkbSendControlsNotify(dev, pCN);
    cause.kc = pCN->keycode;
    cause.event = pCN->eventType;
    cause.mjr = pCN->requestMajor;
    cause.mnr = pCN->requestMinor;
    sli = XkbFindSrvLedInfo(dev, XkbDfltXIClass, XkbDfltXIId, 0);
    XkbUpdateIndicators(dev, sli->usesControls, TRUE, NULL, &cause);
    if (XkbAX_NeedFeedback(ctrls, XkbAX_FeatureFBMask))
        XkbDDXAccessXBeep(dev, _BEEP_FEATURE_ON, KRGControl);
171
    return;
172 173

}                               /* AccessXKRGTurnOn */
174 175 176 177 178 179 180 181

/************************************************************************/
/*									*/
/* AccessXKRGTurnOff							*/
/*									*/
/*	Turn the keyboard response group off.				*/
/*									*/
/************************************************************************/
182 183
static void
AccessXKRGTurnOff(DeviceIntPtr dev, xkbControlsNotify * pCN)
184
{
185 186 187 188 189
    XkbSrvInfoPtr xkbi = dev->key->xkbInfo;
    XkbControlsPtr ctrls = xkbi->desc->ctrls;
    XkbControlsRec old;
    XkbEventCauseRec cause;
    XkbSrvLedInfoPtr sli;
190 191 192

    old = *ctrls;
    ctrls->enabled_ctrls &= ~XkbAX_KRGMask;
193 194 195 196 197 198 199 200 201 202 203 204
    if (XkbComputeControlsNotify(dev, &old, ctrls, pCN, FALSE))
        XkbSendControlsNotify(dev, pCN);
    cause.kc = pCN->keycode;
    cause.event = pCN->eventType;
    cause.mjr = pCN->requestMajor;
    cause.mnr = pCN->requestMinor;
    sli = XkbFindSrvLedInfo(dev, XkbDfltXIClass, XkbDfltXIId, 0);
    XkbUpdateIndicators(dev, sli->usesControls, TRUE, NULL, &cause);
    if (XkbAX_NeedFeedback(ctrls, XkbAX_FeatureFBMask)) {
        unsigned changes = old.enabled_ctrls ^ ctrls->enabled_ctrls;

        XkbDDXAccessXBeep(dev, _BEEP_FEATURE_OFF, changes);
205 206
    }
    return;
207 208

}                               /* AccessXKRGTurnOff */
209 210 211 212 213 214 215 216 217

/************************************************************************/
/*									*/
/* AccessXStickyKeysTurnOn						*/
/*									*/
/*	Turn StickyKeys on.						*/
/*									*/
/************************************************************************/
static void
218
AccessXStickyKeysTurnOn(DeviceIntPtr dev, xkbControlsNotify * pCN)
219
{
220 221 222 223 224
    XkbSrvInfoPtr xkbi = dev->key->xkbInfo;
    XkbControlsPtr ctrls = xkbi->desc->ctrls;
    XkbControlsRec old;
    XkbEventCauseRec cause;
    XkbSrvLedInfoPtr sli;
225 226 227 228

    old = *ctrls;
    ctrls->enabled_ctrls |= XkbStickyKeysMask;
    xkbi->shiftKeyCount = 0;
229 230 231 232 233 234 235 236 237 238
    if (XkbComputeControlsNotify(dev, &old, ctrls, pCN, FALSE))
        XkbSendControlsNotify(dev, pCN);
    cause.kc = pCN->keycode;
    cause.event = pCN->eventType;
    cause.mjr = pCN->requestMajor;
    cause.mnr = pCN->requestMinor;
    sli = XkbFindSrvLedInfo(dev, XkbDfltXIClass, XkbDfltXIId, 0);
    XkbUpdateIndicators(dev, sli->usesControls, TRUE, NULL, &cause);
    if (XkbAX_NeedFeedback(ctrls, XkbAX_FeatureFBMask)) {
        XkbDDXAccessXBeep(dev, _BEEP_FEATURE_ON, XkbStickyKeysMask);
239 240
    }
    return;
241 242

}                               /* AccessXStickyKeysTurnOn */
243 244 245 246 247 248 249 250 251

/************************************************************************/
/*									*/
/* AccessXStickyKeysTurnOff						*/
/*									*/
/*	Turn StickyKeys off.						*/
/*									*/
/************************************************************************/
static void
252
AccessXStickyKeysTurnOff(DeviceIntPtr dev, xkbControlsNotify * pCN)
253
{
254 255 256 257 258
    XkbSrvInfoPtr xkbi = dev->key->xkbInfo;
    XkbControlsPtr ctrls = xkbi->desc->ctrls;
    XkbControlsRec old;
    XkbEventCauseRec cause;
    XkbSrvLedInfoPtr sli;
259 260 261 262

    old = *ctrls;
    ctrls->enabled_ctrls &= ~XkbStickyKeysMask;
    xkbi->shiftKeyCount = 0;
263 264 265 266 267 268 269 270 271 272 273
    if (XkbComputeControlsNotify(dev, &old, ctrls, pCN, FALSE))
        XkbSendControlsNotify(dev, pCN);

    cause.kc = pCN->keycode;
    cause.event = pCN->eventType;
    cause.mjr = pCN->requestMajor;
    cause.mnr = pCN->requestMinor;
    sli = XkbFindSrvLedInfo(dev, XkbDfltXIClass, XkbDfltXIId, 0);
    XkbUpdateIndicators(dev, sli->usesControls, TRUE, NULL, &cause);
    if (XkbAX_NeedFeedback(ctrls, XkbAX_FeatureFBMask)) {
        XkbDDXAccessXBeep(dev, _BEEP_FEATURE_OFF, XkbStickyKeysMask);
274 275
    }
#ifndef NO_CLEAR_LATCHES_FOR_STICKY_KEYS_OFF
276
    XkbClearAllLatchesAndLocks(dev, xkbi, FALSE, &cause);
277 278
#endif
    return;
279
}                               /* AccessXStickyKeysTurnOff */
280 281

static CARD32
282
AccessXKRGExpire(OsTimerPtr timer, CARD32 now, pointer arg)
283
{
284
    xkbControlsNotify cn;
285 286
    DeviceIntPtr dev = arg;
    XkbSrvInfoPtr xkbi = dev->key->xkbInfo;
287 288

    if (xkbi->krgTimerActive == _KRG_WARN_TIMER) {
289
        XkbDDXAccessXBeep(dev, _BEEP_SLOW_WARN, XkbStickyKeysMask);
290 291
        xkbi->krgTimerActive = _KRG_TIMER;
        return 4000;
292
    }
293
    xkbi->krgTimerActive = _OFF_TIMER;
294 295 296 297
    cn.keycode = 0;
    cn.eventType = 0;
    cn.requestMajor = 0;
    cn.requestMinor = 0;
298
    if (xkbi->desc->ctrls->enabled_ctrls & XkbSlowKeysMask) {
299
        AccessXKRGTurnOff(dev, &cn);
300 301 302
        LogMessage(X_INFO, "XKB SlowKeys are disabled.\n");
    }
    else {
303
        AccessXKRGTurnOn(dev, XkbSlowKeysMask, &cn);
304 305 306
        LogMessage(X_INFO, "XKB SlowKeys are now enabled. Hold shift to disable.\n");
    }

307 308 309 310
    return 0;
}

static CARD32
311
AccessXRepeatKeyExpire(OsTimerPtr timer, CARD32 now, pointer arg)
312
{
313 314
    DeviceIntPtr dev = (DeviceIntPtr) arg;
    XkbSrvInfoPtr xkbi = dev->key->xkbInfo;
315

316
    if (xkbi->repeatKey == 0)
317
        return 0;
318

319
    AccessXKeyboardEvent(dev, ET_KeyPress, xkbi->repeatKey, TRUE);
320

321 322 323
    return xkbi->desc->ctrls->repeat_interval;
}

324
void
325
AccessXCancelRepeatKey(XkbSrvInfoPtr xkbi, KeyCode key)
326
{
327 328
    if (xkbi->repeatKey == key)
        xkbi->repeatKey = 0;
329 330 331 332
    return;
}

static CARD32
333
AccessXSlowKeyExpire(OsTimerPtr timer, CARD32 now, pointer arg)
334
{
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
    DeviceIntPtr keybd;
    XkbSrvInfoPtr xkbi;
    XkbDescPtr xkb;
    XkbControlsPtr ctrls;

    keybd = (DeviceIntPtr) arg;
    xkbi = keybd->key->xkbInfo;
    xkb = xkbi->desc;
    ctrls = xkb->ctrls;
    if (xkbi->slowKey != 0) {
        xkbAccessXNotify ev;
        KeySym *sym = XkbKeySymsPtr(xkb, xkbi->slowKey);

        ev.detail = XkbAXN_SKAccept;
        ev.keycode = xkbi->slowKey;
        ev.slowKeysDelay = ctrls->slow_keys_delay;
        ev.debounceDelay = ctrls->debounce_delay;
        XkbSendAccessXNotify(keybd, &ev);
        if (XkbAX_NeedFeedback(ctrls, XkbAX_SKAcceptFBMask))
            XkbDDXAccessXBeep(keybd, _BEEP_SLOW_ACCEPT, XkbSlowKeysMask);
        AccessXKeyboardEvent(keybd, ET_KeyPress, xkbi->slowKey, FALSE);
        /* check for magic sequences */
        if ((ctrls->enabled_ctrls & XkbAccessXKeysMask) &&
            ((sym[0] == XK_Shift_R) || (sym[0] == XK_Shift_L)))
            xkbi->shiftKeyCount++;

        /* Start repeating if necessary.  Stop autorepeating if the user
         * presses a non-modifier key that doesn't autorepeat.
         */
        if (keybd->kbdfeed->ctrl.autoRepeat &&
            ((xkbi->slowKey != xkbi->mouseKey) || (!xkbi->mouseKeysAccel)) &&
            (ctrls->enabled_ctrls & XkbRepeatKeysMask)) {
            if (BitIsOn(keybd->kbdfeed->ctrl.autoRepeats, xkbi->slowKey)) {
                xkbi->repeatKey = xkbi->slowKey;
                xkbi->repeatKeyTimer = TimerSet(xkbi->repeatKeyTimer,
                                                0, ctrls->repeat_delay,
                                                AccessXRepeatKeyExpire,
                                                (pointer) keybd);
            }
        }
375 376 377 378 379
    }
    return 0;
}

static CARD32
380
AccessXBounceKeyExpire(OsTimerPtr timer, CARD32 now, pointer arg)
381
{
382
    XkbSrvInfoPtr xkbi = ((DeviceIntPtr) arg)->key->xkbInfo;
383

384
    xkbi->inactiveKey = 0;
385 386 387 388
    return 0;
}

static CARD32
389
AccessXTimeoutExpire(OsTimerPtr timer, CARD32 now, pointer arg)
390
{
391 392 393 394 395 396 397
    DeviceIntPtr dev = (DeviceIntPtr) arg;
    XkbSrvInfoPtr xkbi = dev->key->xkbInfo;
    XkbControlsPtr ctrls = xkbi->desc->ctrls;
    XkbControlsRec old;
    xkbControlsNotify cn;
    XkbEventCauseRec cause;
    XkbSrvLedInfoPtr sli;
398 399

    if (xkbi->lastPtrEventTime) {
400 401
        unsigned timeToWait = (ctrls->ax_timeout * 1000);
        unsigned timeElapsed = (now - xkbi->lastPtrEventTime);
402

403 404
        if (timeToWait > timeElapsed)
            return timeToWait - timeElapsed;
405
    }
406 407 408 409
    old = *ctrls;
    xkbi->shiftKeyCount = 0;
    ctrls->enabled_ctrls &= ~ctrls->axt_ctrls_mask;
    ctrls->enabled_ctrls |= (ctrls->axt_ctrls_values & ctrls->axt_ctrls_mask);
410
    if (ctrls->axt_opts_mask) {
411 412
        ctrls->ax_options &= ~ctrls->axt_opts_mask;
        ctrls->ax_options |= (ctrls->axt_opts_values & ctrls->axt_opts_mask);
413
    }
414 415 416 417 418 419
    if (XkbComputeControlsNotify(dev, &old, ctrls, &cn, FALSE)) {
        cn.keycode = 0;
        cn.eventType = 0;
        cn.requestMajor = 0;
        cn.requestMinor = 0;
        XkbSendControlsNotify(dev, &cn);
420 421
    }
    XkbSetCauseUnknown(&cause);
422 423 424 425 426 427 428 429 430 431 432 433 434 435
    sli = XkbFindSrvLedInfo(dev, XkbDfltXIClass, XkbDfltXIId, 0);
    XkbUpdateIndicators(dev, sli->usesControls, TRUE, NULL, &cause);
    if (ctrls->ax_options != old.ax_options) {
        unsigned set, cleared, bell;

        set = ctrls->ax_options & (~old.ax_options);
        cleared = (~ctrls->ax_options) & old.ax_options;
        if (set && cleared)
            bell = _BEEP_FEATURE_CHANGE;
        else if (set)
            bell = _BEEP_FEATURE_ON;
        else
            bell = _BEEP_FEATURE_OFF;
        XkbDDXAccessXBeep(dev, bell, XkbAccessXTimeoutMask);
436
    }
437
    xkbi->krgTimerActive = _OFF_TIMER;
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
    return 0;
}

/************************************************************************/
/*									*/
/* AccessXFilterPressEvent						*/
/*									*/
/* Filter events before they get any further if SlowKeys is turned on.	*/
/* In addition, this routine handles the ever so popular magic key	*/
/* acts for turning various accessibility features on/off.		*/
/*									*/
/* Returns TRUE if this routine has discarded the event.		*/
/* Returns FALSE if the event needs further processing.			*/
/*									*/
/************************************************************************/
453
Bool
454
AccessXFilterPressEvent(DeviceEvent *event, DeviceIntPtr keybd)
455
{
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
    XkbSrvInfoPtr xkbi = keybd->key->xkbInfo;
    XkbControlsPtr ctrls = xkbi->desc->ctrls;
    Bool ignoreKeyEvent = FALSE;
    KeyCode key = event->detail.key;
    KeySym *sym = XkbKeySymsPtr(xkbi->desc, key);

    if (ctrls->enabled_ctrls & XkbAccessXKeysMask) {
        /* check for magic sequences */
        if ((sym[0] == XK_Shift_R) || (sym[0] == XK_Shift_L)) {
            if (XkbAX_NeedFeedback(ctrls, XkbAX_SlowWarnFBMask)) {
                xkbi->krgTimerActive = _KRG_WARN_TIMER;
                xkbi->krgTimer = TimerSet(xkbi->krgTimer, 0, 4000,
                                          AccessXKRGExpire, (pointer) keybd);
            }
            else {
                xkbi->krgTimerActive = _KRG_TIMER;
                xkbi->krgTimer = TimerSet(xkbi->krgTimer, 0, 8000,
                                          AccessXKRGExpire, (pointer) keybd);
            }
            if (!(ctrls->enabled_ctrls & XkbSlowKeysMask)) {
                CARD32 now = GetTimeInMillis();

                if ((now - xkbi->lastShiftEventTime) > 15000)
                    xkbi->shiftKeyCount = 1;
                else
                    xkbi->shiftKeyCount++;
                xkbi->lastShiftEventTime = now;
            }
        }
        else {
            if (xkbi->krgTimerActive) {
                xkbi->krgTimer = TimerSet(xkbi->krgTimer, 0, 0, NULL, NULL);
                xkbi->krgTimerActive = _OFF_TIMER;
            }
        }
491
    }
492

493 494 495 496 497
    /* Don't transmit the KeyPress if SlowKeys is turned on;
     * The wakeup handler will synthesize one for us if the user
     * has held the key long enough.
     */
    if (ctrls->enabled_ctrls & XkbSlowKeysMask) {
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
        xkbAccessXNotify ev;

        /* If key was already pressed, ignore subsequent press events
         * from the server's autorepeat
         */
        if (xkbi->slowKey == key)
            return TRUE;
        ev.detail = XkbAXN_SKPress;
        ev.keycode = key;
        ev.slowKeysDelay = ctrls->slow_keys_delay;
        ev.debounceDelay = ctrls->debounce_delay;
        XkbSendAccessXNotify(keybd, &ev);
        if (XkbAX_NeedFeedback(ctrls, XkbAX_SKPressFBMask))
            XkbDDXAccessXBeep(keybd, _BEEP_SLOW_PRESS, XkbSlowKeysMask);
        xkbi->slowKey = key;
        xkbi->slowKeysTimer = TimerSet(xkbi->slowKeysTimer,
                                       0, ctrls->slow_keys_delay,
                                       AccessXSlowKeyExpire, (pointer) keybd);
        ignoreKeyEvent = TRUE;
517 518 519 520 521 522
    }

    /* Don't transmit the KeyPress if BounceKeys is turned on
     * and the user pressed the same key within a given time period
     * from the last release.
     */
523 524 525 526 527
    else if ((ctrls->enabled_ctrls & XkbBounceKeysMask) &&
             (key == xkbi->inactiveKey)) {
        if (XkbAX_NeedFeedback(ctrls, XkbAX_BKRejectFBMask))
            XkbDDXAccessXBeep(keybd, _BEEP_BOUNCE_REJECT, XkbBounceKeysMask);
        ignoreKeyEvent = TRUE;
528 529 530 531 532 533
    }

    /* Start repeating if necessary.  Stop autorepeating if the user
     * presses a non-modifier key that doesn't autorepeat.
     */
    if (XkbDDXUsesSoftRepeat(keybd)) {
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550
        if ((keybd->kbdfeed->ctrl.autoRepeat) &&
            ((ctrls->enabled_ctrls & (XkbSlowKeysMask | XkbRepeatKeysMask)) ==
             XkbRepeatKeysMask)) {
            if (BitIsOn(keybd->kbdfeed->ctrl.autoRepeats, key)) {
                if (xkbDebugFlags & 0x10)
                    DebugF("Starting software autorepeat...\n");
                if (xkbi->repeatKey == key)
                    ignoreKeyEvent = TRUE;
                else {
                    xkbi->repeatKey = key;
                    xkbi->repeatKeyTimer = TimerSet(xkbi->repeatKeyTimer,
                                                    0, ctrls->repeat_delay,
                                                    AccessXRepeatKeyExpire,
                                                    (pointer) keybd);
                }
            }
        }
551
    }
552

553 554 555
    /* Check for two keys being pressed at the same time.  This section
     * essentially says the following:
     *
556
     *  If StickyKeys is on, and a modifier is currently being held down,
557 558 559 560
     *  and one of the following is true:  the current key is not a modifier
     *  or the currentKey is a modifier, but not the only modifier being
     *  held down, turn StickyKeys off if the TwoKeys off ctrl is set.
     */
561 562 563 564 565 566 567 568 569 570
    if ((ctrls->enabled_ctrls & XkbStickyKeysMask) &&
        (xkbi->state.base_mods != 0) &&
        (XkbAX_NeedOption(ctrls, XkbAX_TwoKeysMask))) {
        xkbControlsNotify cn;

        cn.keycode = key;
        cn.eventType = KeyPress;
        cn.requestMajor = 0;
        cn.requestMinor = 0;
        AccessXStickyKeysTurnOff(keybd, &cn);
571
    }
572

573
    if (!ignoreKeyEvent)
574
        XkbProcessKeyboardEvent(event, keybd);
575
    return ignoreKeyEvent;
576
}                               /* AccessXFilterPressEvent */
577 578 579 580 581 582 583 584 585 586 587 588 589

/************************************************************************/
/*									*/
/* AccessXFilterReleaseEvent						*/
/*									*/
/* Filter events before they get any further if SlowKeys is turned on.	*/
/* In addition, this routine handles the ever so popular magic key	*/
/* acts for turning various accessibility features on/off.		*/
/*									*/
/* Returns TRUE if this routine has discarded the event.		*/
/* Returns FALSE if the event needs further processing.			*/
/*									*/
/************************************************************************/
590
Bool
591
AccessXFilterReleaseEvent(DeviceEvent *event, DeviceIntPtr keybd)
592
{
593 594 595 596 597
    XkbSrvInfoPtr xkbi = keybd->key->xkbInfo;
    XkbControlsPtr ctrls = xkbi->desc->ctrls;
    KeyCode key = event->detail.key;
    Bool ignoreKeyEvent = FALSE;

598 599 600 601 602
    /* Don't transmit the KeyRelease if BounceKeys is on and
     * this is the release of a key that was ignored due to 
     * BounceKeys.
     */
    if (ctrls->enabled_ctrls & XkbBounceKeysMask) {
603 604 605 606 607 608 609
        if ((key != xkbi->mouseKey) && (!BitIsOn(keybd->key->down, key)))
            ignoreKeyEvent = TRUE;
        xkbi->inactiveKey = key;
        xkbi->bounceKeysTimer = TimerSet(xkbi->bounceKeysTimer, 0,
                                         ctrls->debounce_delay,
                                         AccessXBounceKeyExpire,
                                         (pointer) keybd);
610 611 612 613 614 615 616
    }

    /* Don't transmit the KeyRelease if SlowKeys is turned on and
     * the user didn't hold the key long enough.  We know we passed
     * the key if the down bit was set by CoreProcessKeyboadEvent.
     */
    if (ctrls->enabled_ctrls & XkbSlowKeysMask) {
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
        xkbAccessXNotify ev;
        unsigned beep_type;

        ev.keycode = key;
        ev.slowKeysDelay = ctrls->slow_keys_delay;
        ev.debounceDelay = ctrls->debounce_delay;
        if (BitIsOn(keybd->key->down, key) || (xkbi->mouseKey == key)) {
            ev.detail = XkbAXN_SKRelease;
            beep_type = _BEEP_SLOW_RELEASE;
        }
        else {
            ev.detail = XkbAXN_SKReject;
            beep_type = _BEEP_SLOW_REJECT;
            ignoreKeyEvent = TRUE;
        }
        XkbSendAccessXNotify(keybd, &ev);
        if (XkbAX_NeedFeedback(ctrls, XkbAX_SKRejectFBMask)) {
            XkbDDXAccessXBeep(keybd, beep_type, XkbSlowKeysMask);
        }
        if (xkbi->slowKey == key)
            xkbi->slowKey = 0;
638 639 640 641 642
    }

    /* Stop Repeating if the user releases the key that is currently
     * repeating.
     */
643 644
    if (xkbi->repeatKey == key) {
        xkbi->repeatKey = 0;
645 646
    }

647 648 649 650 651 652 653
    if ((ctrls->enabled_ctrls & XkbAccessXTimeoutMask) &&
        (ctrls->ax_timeout > 0)) {
        xkbi->lastPtrEventTime = 0;
        xkbi->krgTimer = TimerSet(xkbi->krgTimer, 0,
                                  ctrls->ax_timeout * 1000,
                                  AccessXTimeoutExpire, (pointer) keybd);
        xkbi->krgTimerActive = _ALL_TIMEOUT_TIMER;
654
    }
655 656 657
    else if (xkbi->krgTimerActive != _OFF_TIMER) {
        xkbi->krgTimer = TimerSet(xkbi->krgTimer, 0, 0, NULL, NULL);
        xkbi->krgTimerActive = _OFF_TIMER;
658
    }
659

660 661 662 663
    /* Keep track of how many times the Shift key has been pressed.
     * If it has been pressed and released 5 times in a row, toggle
     * the state of StickyKeys.
     */
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
    if ((!ignoreKeyEvent) && (xkbi->shiftKeyCount)) {
        KeySym *pSym = XkbKeySymsPtr(xkbi->desc, key);

        if ((pSym[0] != XK_Shift_L) && (pSym[0] != XK_Shift_R)) {
            xkbi->shiftKeyCount = 0;
        }
        else if (xkbi->shiftKeyCount >= 5) {
            xkbControlsNotify cn;

            cn.keycode = key;
            cn.eventType = KeyPress;
            cn.requestMajor = 0;
            cn.requestMinor = 0;
            if (ctrls->enabled_ctrls & XkbStickyKeysMask)
                AccessXStickyKeysTurnOff(keybd, &cn);
            else
                AccessXStickyKeysTurnOn(keybd, &cn);
            xkbi->shiftKeyCount = 0;
        }
683
    }
684

685
    if (!ignoreKeyEvent)
686
        XkbProcessKeyboardEvent(event, keybd);
687
    return ignoreKeyEvent;
688 689

}                               /* AccessXFilterReleaseEvent */
690 691 692 693 694 695 696 697 698 699 700

/************************************************************************/
/*									*/
/* ProcessPointerEvent							*/
/*									*/
/* This routine merely sets the shiftKeyCount and clears the keyboard   */
/* response group timer (if necessary) on a mouse event.  This is so	*/
/* multiple shifts with just the mouse and shift-drags with the mouse	*/
/* don't accidentally turn on StickyKeys or the Keyboard Response Group.*/
/*									*/
/************************************************************************/
701
extern int xkbDevicePrivateIndex;
702
void
703
ProcessPointerEvent(InternalEvent *ev, DeviceIntPtr mouse)
704
{
705 706 707 708 709 710
    DeviceIntPtr dev;
    XkbSrvInfoPtr xkbi = NULL;
    unsigned changed = 0;
    ProcessInputProc backupproc;
    xkbDeviceInfoPtr xkbPrivPtr = XKBDEVICEINFO(mouse);
    DeviceEvent *event = &ev->device_event;
711

Peter Hutterer's avatar
Peter Hutterer committed
712
    dev = IsFloating(mouse) ? mouse : GetMaster(mouse, MASTER_KEYBOARD);
713

714 715 716 717
    if (dev && dev->key) {
        xkbi = dev->key->xkbInfo;
        xkbi->shiftKeyCount = 0;
        xkbi->lastPtrEventTime = event->time;
718
    }
719

720
    if (event->type == ET_ButtonPress) {
721
        changed |= XkbPointerButtonMask;
722
    }
723
    else if (event->type == ET_ButtonRelease) {
724 725
        if (xkbi) {
            xkbi->lockedPtrButtons &= ~(1 << (event->detail.key & 0x7));
726

727
            if (IsMaster(dev)) {
728 729
                DeviceIntPtr source;
                int rc;
730 731 732

                rc = dixLookupDevice(&source, event->sourceid, serverClient,
                                     DixWriteAccess);
733
                if (rc != Success)
734 735
                    ErrorF("[xkb] bad sourceid '%d' on button release event.\n",
                           event->sourceid);
736 737 738
                else if (!IsXTestDevice(source, GetMaster(dev, MASTER_POINTER)))
                    XkbFakeDeviceButton(dev, FALSE, event->detail.key);
            }
739
        }
740

741
        changed |= XkbPointerButtonMask;
742
    }
743 744

    UNWRAP_PROCESS_INPUT_PROC(mouse, xkbPrivPtr, backupproc);
745
    mouse->public.processInputProc(ev, mouse);
746
    COND_WRAP_PROCESS_INPUT_PROC(mouse, xkbPrivPtr, backupproc, xkbUnwrapProc);
747

748
    if (!xkbi)
749
        return;
750

751
    xkbi->state.ptr_buttons = (mouse->button) ? mouse->button->state : 0;
752

753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773
    /* clear any latched modifiers */
    if (xkbi->state.latched_mods && (event->type == ET_ButtonRelease)) {
        unsigned changed_leds;
        XkbStateRec oldState;
        XkbSrvLedInfoPtr sli;

        sli = XkbFindSrvLedInfo(dev, XkbDfltXIClass, XkbDfltXIId, 0);
        oldState = xkbi->state;
        XkbLatchModifiers(dev, 0xFF, 0x00);

        XkbComputeDerivedState(xkbi);
        changed |= XkbStateChangedFlags(&oldState, &xkbi->state);
        if (changed & sli->usedComponents) {
            changed_leds = XkbIndicatorsToUpdate(dev, changed, FALSE);
            if (changed_leds) {
                XkbEventCauseRec cause;

                XkbSetCauseKey(&cause, (event->detail.key & 0x7), event->type);
                XkbUpdateIndicators(dev, changed_leds, TRUE, NULL, &cause);
            }
        }
774 775
    }

776 777
    if (((xkbi->flags & _XkbStateNotifyInProgress) == 0) && (changed != 0)) {
        xkbStateNotify sn;
778

779 780 781 782 783 784
        sn.keycode = event->detail.key;
        sn.eventType = event->type;
        sn.requestMajor = sn.requestMinor = 0;
        sn.changed = changed;
        XkbSendStateNotify(dev, &sn);
    }
785

786
}                               /* ProcessPointerEvent */