summaryrefslogtreecommitdiffstats
path: root/include/Xserver/input.h
blob: 63421dedd2d514d437f4d5e3f0bef1627b3e91cc (plain)
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
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
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
/* $XConsortium: input.h /main/22 1996/09/25 00:50:39 dpw $ */
/* $XFree86: xc/programs/Xserver/include/input.h,v 3.4 1996/12/23 07:09:28 dawes Exp $ */
/************************************************************

Copyright (c) 1987  X Consortium

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of the X Consortium shall not be
used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from the X Consortium.


Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts.

                        All Rights Reserved

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 Digital not be
used in advertising or publicity pertaining to distribution of the
software without specific, written prior permission.  

DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
DIGITAL 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.

********************************************************/
#ifndef INPUT_H
#define INPUT_H

#include "misc.h"
#include "screenint.h"
#include "X11/Xmd.h"
#include "X11/Xproto.h"
#include "window.h"     /* for WindowPtr */

#define DEVICE_INIT	0
#define DEVICE_ON	1
#define DEVICE_OFF	2
#define DEVICE_CLOSE	3

#define MAP_LENGTH	256
#define DOWN_LENGTH	32	/* 256/8 => number of bytes to hold 256 bits */
#define NullGrab ((GrabPtr)NULL)
#define PointerRootWin ((WindowPtr)PointerRoot)
#define NoneWin ((WindowPtr)None)
#define NullDevice ((DevicePtr)NULL)

#ifndef FollowKeyboard
#define FollowKeyboard 		3
#endif
#ifndef FollowKeyboardWin
#define FollowKeyboardWin  ((WindowPtr) FollowKeyboard)
#endif
#ifndef RevertToFollowKeyboard
#define RevertToFollowKeyboard	3
#endif

typedef unsigned long Leds;
typedef struct _OtherClients *OtherClientsPtr;
typedef struct _InputClients *InputClientsPtr;
typedef struct _DeviceIntRec *DeviceIntPtr;

typedef int (*DeviceProc)(
#if NeedNestedPrototypes
    DeviceIntPtr /*device*/,
    int /*what*/
#endif
);

typedef void (*ProcessInputProc)(
#if NeedNestedPrototypes
    xEventPtr /*events*/,
    DeviceIntPtr /*device*/,
    int /*count*/
#endif
);

typedef struct _DeviceRec {
    pointer	devicePrivate;
    ProcessInputProc processInputProc;	/* current */
    ProcessInputProc realInputProc;	/* deliver */
    ProcessInputProc enqueueInputProc;	/* enqueue */
    Bool	on;			/* used by DDX to keep state */
} DeviceRec, *DevicePtr;

typedef struct {
    int			click, bell, bell_pitch, bell_duration;
    Bool		autoRepeat;
    unsigned char	autoRepeats[32];
    Leds		leds;
    unsigned char	id;
} KeybdCtrl;

typedef struct {
    KeySym  *map;
    KeyCode minKeyCode,
	    maxKeyCode;
    int     mapWidth;
} KeySymsRec, *KeySymsPtr;

typedef struct {
    int		num, den, threshold;
    unsigned char id;
} PtrCtrl;

typedef struct {
    int         resolution, min_value, max_value;
    int         integer_displayed;
    unsigned char id;
} IntegerCtrl;

typedef struct {
    int         max_symbols, num_symbols_supported;
    int         num_symbols_displayed;
    KeySym      *symbols_supported;
    KeySym      *symbols_displayed;
    unsigned char id;
} StringCtrl;

typedef struct {
    int         percent, pitch, duration;
    unsigned char id;
} BellCtrl;

typedef struct {
    Leds        led_values;
    Mask        led_mask;
    unsigned char id;
} LedCtrl;

extern KeybdCtrl	defaultKeyboardControl;
extern PtrCtrl		defaultPointerControl;

#undef  AddInputDevice
extern DevicePtr AddInputDevice(
#if NeedFunctionPrototypes
    DeviceProc /*deviceProc*/,
    Bool /*autoStart*/
#endif
);

#define AddInputDevice(deviceProc, autoStart) \
       _AddInputDevice(deviceProc, autoStart)

extern DeviceIntPtr _AddInputDevice(
#if NeedFunctionPrototypes
    DeviceProc /*deviceProc*/,
    Bool /*autoStart*/
#endif
);

extern Bool EnableDevice(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/
#endif
);

extern Bool DisableDevice(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/
#endif
);

extern int InitAndStartDevices(
#if NeedFunctionPrototypes
    void
#endif
);

extern void CloseDownDevices(
#if NeedFunctionPrototypes
    void
#endif
);

extern void RemoveDevice(
#if NeedFunctionPrototypes
    DeviceIntPtr /*dev*/
#endif
);

extern int NumMotionEvents(
#if NeedFunctionPrototypes
    void
#endif
);

#undef  RegisterPointerDevice
extern void RegisterPointerDevice(
#if NeedFunctionPrototypes
    DevicePtr /*device*/
#endif
);

#define RegisterPointerDevice(device) \
       _RegisterPointerDevice(device)

extern void _RegisterPointerDevice(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/
#endif
);

#undef  RegisterKeyboardDevice
extern void RegisterKeyboardDevice(
#if NeedFunctionPrototypes
    DevicePtr /*device*/
#endif
);

#define RegisterKeyboardDevice(device) \
       _RegisterKeyboardDevice(device)

extern void _RegisterKeyboardDevice(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/
#endif
);

extern DevicePtr LookupKeyboardDevice(
#if NeedFunctionPrototypes
    void
#endif
);

extern DevicePtr LookupPointerDevice(
#if NeedFunctionPrototypes
    void
#endif
);

extern DevicePtr LookupDevice(
#if NeedFunctionPrototypes
    int /* id */
#endif
);

extern void QueryMinMaxKeyCodes(
#if NeedFunctionPrototypes
    KeyCode* /*minCode*/,
    KeyCode* /*maxCode*/
#endif
);

extern Bool SetKeySymsMap(
#if NeedFunctionPrototypes
    KeySymsPtr /*dst*/,
    KeySymsPtr /*src*/
#endif
);

extern Bool InitKeyClassDeviceStruct(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/,
    KeySymsPtr /*pKeySyms*/,
    CARD8 /*pModifiers*/[]
#endif
);

extern Bool InitButtonClassDeviceStruct(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/,
    int /*numButtons*/,
    CARD8* /*map*/
#endif
);

typedef int (*ValuatorMotionProcPtr)(
#if NeedNestedPrototypes
		DeviceIntPtr /*pdevice*/,
		xTimecoord * /*coords*/,
		unsigned long /*start*/,
		unsigned long /*stop*/,
		ScreenPtr /*pScreen*/
#endif
);

extern Bool InitValuatorClassDeviceStruct(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/,
    int /*numAxes*/,
    ValuatorMotionProcPtr /* motionProc */,
    int /*numMotionEvents*/,
    int /*mode*/
#endif
);

extern Bool InitFocusClassDeviceStruct(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/
#endif
);

typedef void (*BellProcPtr)(
#if NeedNestedPrototypes
    int /*percent*/,
    DeviceIntPtr /*device*/,
    pointer /*ctrl*/,
    int
#endif
);

typedef void (*KbdCtrlProcPtr)(
#if NeedNestedPrototypes
    DeviceIntPtr /*device*/,
    KeybdCtrl * /*ctrl*/
#endif				     
);

extern Bool InitKbdFeedbackClassDeviceStruct(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/,
    BellProcPtr /*bellProc*/,
    KbdCtrlProcPtr /*controlProc*/
#endif
);

typedef void (*PtrCtrlProcPtr)(
#if NeedNestedPrototypes
    DeviceIntPtr /*device*/,
    PtrCtrl * /*ctrl*/
#endif				     
);

extern Bool InitPtrFeedbackClassDeviceStruct(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/,
    PtrCtrlProcPtr /*controlProc*/
#endif
);

typedef void (*StringCtrlProcPtr)(
#if NeedNestedPrototypes
    DeviceIntPtr /*device*/,
    StringCtrl * /*ctrl*/
#endif				     
);

extern Bool InitStringFeedbackClassDeviceStruct(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/,
    StringCtrlProcPtr /*controlProc*/,
    int /*max_symbols*/,
    int /*num_symbols_supported*/,
    KeySym* /*symbols*/
#endif
);

typedef void (*BellCtrlProcPtr)(
#if NeedNestedPrototypes
    DeviceIntPtr /*device*/,
    BellCtrl * /*ctrl*/
#endif				     
);

extern Bool InitBellFeedbackClassDeviceStruct(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/,
    BellProcPtr /*bellProc*/,
    BellCtrlProcPtr /*controlProc*/
#endif
);

typedef void (*LedCtrlProcPtr)(
#if NeedNestedPrototypes
    DeviceIntPtr /*device*/,
    LedCtrl * /*ctrl*/
#endif				     
);

extern Bool InitLedFeedbackClassDeviceStruct(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/,
    LedCtrlProcPtr /*controlProc*/
#endif
);

typedef void (*IntegerCtrlProcPtr)(
#if NeedNestedPrototypes
    DeviceIntPtr /*device*/,
    IntegerCtrl * /*ctrl*/
#endif
);


extern Bool InitIntegerFeedbackClassDeviceStruct(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/,
    IntegerCtrlProcPtr /*controlProc*/
#endif
);

extern Bool InitPointerDeviceStruct(
#if NeedFunctionPrototypes
    DevicePtr /*device*/,
    CARD8* /*map*/,
    int /*numButtons*/,
    ValuatorMotionProcPtr /*motionProc*/,
    PtrCtrlProcPtr /*controlProc*/,
    int /*numMotionEvents*/
#endif
);

extern Bool InitKeyboardDeviceStruct(
#if NeedFunctionPrototypes
    DevicePtr /*device*/,
    KeySymsPtr /*pKeySyms*/,
    CARD8 /*pModifiers*/[],
    BellProcPtr /*bellProc*/,
    KbdCtrlProcPtr /*controlProc*/
#endif
);

extern void SendMappingNotify(
#if NeedFunctionPrototypes
    unsigned int /*request*/,
    unsigned int /*firstKeyCode*/,
    unsigned int /*count*/,
    ClientPtr	/* client */
#endif
);

extern Bool BadDeviceMap(
#if NeedFunctionPrototypes
    BYTE* /*buff*/,
    int /*length*/,
    unsigned /*low*/,
    unsigned /*high*/,
    XID* /*errval*/
#endif
);

extern Bool AllModifierKeysAreUp(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/,
    CARD8* /*map1*/,
    int /*per1*/,
    CARD8* /*map2*/,
    int /*per2*/
#endif
);

extern void NoteLedState(
#if NeedFunctionPrototypes
    DeviceIntPtr /*keybd*/,
    int /*led*/,
    Bool /*on*/
#endif
);

extern void MaybeStopHint(
#if NeedFunctionPrototypes
    DeviceIntPtr /*device*/,
    ClientPtr /*client*/
#endif
);

extern void ProcessPointerEvent(
#if NeedFunctionPrototypes
    xEventPtr /*xE*/,
    DeviceIntPtr /*mouse*/,
    int /*count*/
#endif
);

extern void ProcessKeyboardEvent(
#if NeedFunctionPrototypes
    xEventPtr /*xE*/,
    DeviceIntPtr /*keybd*/,
    int /*count*/
#endif
);

#ifdef XKB
extern void CoreProcessPointerEvent(
#if NeedFunctionPrototypes
    xEventPtr /*xE*/,
    DeviceIntPtr /*mouse*/,
    int /*count*/
#endif
);

extern void CoreProcessKeyboardEvent(
#if NeedFunctionPrototypes
    xEventPtr /*xE*/,
    DeviceIntPtr /*keybd*/,
    int /*count*/
#endif
);
#endif

extern Bool LegalModifier(
#if NeedFunctionPrototypes
    unsigned int /*key*/, 
    DevicePtr /*pDev*/
#endif
);

extern void ProcessInputEvents(
#if NeedFunctionPrototypes
    void
#endif
);

extern void InitInput(
#if NeedFunctionPrototypes
    int  /*argc*/,
    char ** /*argv*/
#endif
);

#endif /* INPUT_H */
OpenPOWER on IntegriCloud