b0ed4155dd4c359d793723cad88f7a456bb21149
[platform/upstream/libxkbcommon.git] / src / xkbcomp / indicators.h
1 /************************************************************
2  Copyright (c) 1994 by Silicon Graphics Computer Systems, Inc.
3
4  Permission to use, copy, modify, and distribute this
5  software and its documentation for any purpose and without
6  fee is hereby granted, provided that the above copyright
7  notice appear in all copies and that both that copyright
8  notice and this permission notice appear in supporting
9  documentation, and that the name of Silicon Graphics not be
10  used in advertising or publicity pertaining to distribution
11  of the software without specific prior written permission.
12  Silicon Graphics makes no representation about the suitability
13  of this software for any purpose. It is provided "as is"
14  without any express or implied warranty.
15
16  SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
17  SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
18  AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
19  GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
20  DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
21  DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
22  OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION  WITH
23  THE USE OR PERFORMANCE OF THIS SOFTWARE.
24
25  ********************************************************/
26
27 #ifndef INDICATORS_H
28 #define INDICATORS_H 1
29
30 #include "xkbcomp-priv.h"
31
32 #define _LED_Index      (1<<0)
33 #define _LED_Mods       (1<<1)
34 #define _LED_Groups     (1<<2)
35 #define _LED_Ctrls      (1<<3)
36 #define _LED_Explicit   (1<<4)
37 #define _LED_Automatic  (1<<5)
38 #define _LED_DrivesKbd  (1<<6)
39
40 #define _LED_NotBound   255
41
42 typedef struct _LEDInfo
43 {
44     CommonInfo defs;
45     xkb_atom_t name;
46     unsigned char indicator;
47     unsigned char flags;
48     unsigned char which_mods;
49     unsigned char real_mods;
50     unsigned short vmods;
51     unsigned char which_groups;
52     unsigned char groups;
53     unsigned int ctrls;
54 } LEDInfo;
55
56 extern void
57 ClearIndicatorMapInfo(struct xkb_ctx *ctx, LEDInfo *info);
58
59
60 extern LEDInfo *
61 AddIndicatorMap(struct xkb_keymap *keymap, LEDInfo *oldLEDs, LEDInfo *newLED);
62
63 extern int
64 SetIndicatorMapField(LEDInfo *led, struct xkb_keymap *keymap, char *field,
65                      ExprDef *arrayNdx, ExprDef *value);
66
67 extern LEDInfo *
68 HandleIndicatorMapDef(IndicatorMapDef *stmt, struct xkb_keymap *keymap,
69                       LEDInfo *dflt, LEDInfo *oldLEDs, unsigned mergeMode);
70
71 extern bool
72 CopyIndicatorMapDefs(struct xkb_keymap *keymap, LEDInfo *leds,
73                      LEDInfo **unboundRtrn);
74
75 extern bool
76 BindIndicators(struct xkb_keymap *keymap, bool force, LEDInfo *unbound,
77                LEDInfo **unboundRtrn);
78
79 #endif /* INDICATORS_H */