8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync/************************************************************
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncCopyright (c) 1993 by Silicon Graphics Computer Systems, Inc.
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncPermission to use, copy, modify, and distribute this
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncsoftware and its documentation for any purpose and without
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncfee is hereby granted, provided that the above copyright
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncnotice appear in all copies and that both that copyright
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncnotice and this permission notice appear in supporting
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncdocumentation, and that the name of Silicon Graphics not be
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncused in advertising or publicity pertaining to distribution
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncof the software without specific prior written permission.
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncSilicon Graphics makes no representation about the suitability
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncof this software for any purpose. It is provided "as is"
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncwithout any express or implied warranty.
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncSILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncSOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncAND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncGRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncDAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncDATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncOR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsyncTHE USE OR PERFORMANCE OF THIS SOFTWARE.
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync********************************************************/
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbCharToInt(v) ((int) ((v) & 0x80 ? ((v) | (~0xff)) : ((v) & 0x7f)))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbIntTo2Chars(i, h, l) ((h) = (i >> 8) & 0xff, (l) = (i) & 0xff)
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync * Common data structures and access macros
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync /* FIXME: Why are base + latched short and not char?? */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync unsigned short base_group; /* physically ... down? */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync unsigned char compat_state; /* mods + group for core state */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync /* grab mods = all depressed and latched mods, _not_ locked mods */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync unsigned char grab_mods; /* grab mods minus internal mods */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync unsigned char compat_grab_mods; /* grab mods + group for core state,
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync but not locked groups if
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync IgnoreGroupLocks set */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync /* effective mods = all mods (depressed, latched, locked) */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync unsigned char lookup_mods; /* effective mods minus internal mods */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync unsigned char compat_lookup_mods; /* effective mods + group */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync unsigned short ptr_buttons; /* core pointer buttons */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbStateFieldFromRec(s) XkbBuildCoreState((s)->lookup_mods,(s)->group)
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbGrabStateFromRec(s) XkbBuildCoreState((s)->grab_mods,(s)->group)
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbSetGroupInfo(g, w, n) (((w) & 0xc0) | (((n) & 3) << 4) | \
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync ((g) & 0x0f))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbSetNumGroups(g,n) (((g)&0xf0)|((n)&0x0f))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync * Structures and access macros used primarily by the server
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync /* FIXME: Make this an int. */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbModActionVMods(a) ((short) (((a)->vmods1 << 8) | (a)->vmods2))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync /* FIXME: Make this an int. */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbSAGroup(a) (XkbCharToInt((a)->group_XXX))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync /* FIXME: Make this an int. */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync /* FIXME: Make this an int. */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbPtrActionX(a) (Xkb2CharsToInt((a)->high_XXX,(a)->low_XXX))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbPtrActionY(a) (Xkb2CharsToInt((a)->high_YYY,(a)->low_YYY))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbSetPtrActionX(a,x) (XkbIntTo2Chars(x,(a)->high_XXX,(a)->low_XXX))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbSetPtrActionY(a,y) (XkbIntTo2Chars(y,(a)->high_YYY,(a)->low_YYY))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbSAPtrDfltValue(a) (XkbCharToInt((a)->valueXXX))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbSASetPtrDfltValue(a, c) ((a)->valueXXX = (c) & 0xff)
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbSAScreen(a) (XkbCharToInt((a)->screenXXX))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbSASetScreen(a, s) ((a)->screenXXX = (s) & 0xff)
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync /* FIXME: Make this an int. */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbActionSetCtrls(a, c) ((a)->ctrls3 = ((c) >> 24) & 0xff, \
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbActionCtrls(a) ((((unsigned int)(a)->ctrls3)<<24)|\
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync ((unsigned int) (a)->ctrls0))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync /* FIXME: Make this an int. */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbSARedirectVMods(a) ((((unsigned int)(a)->vmods1)<<8)|\
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync ((unsigned int)(a)->vmods0))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync/* FIXME: This is blatantly not setting vmods. Yeesh. */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbSARedirectSetVMods(a,m) (((a)->vmods_mask1=(((m)>>8)&0xff)),\
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbSARedirectVModsMask(a) ((((unsigned int)(a)->vmods_mask1)<<8)|\
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync ((unsigned int)(a)->vmods_mask0))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbSARedirectSetVModsMask(a,m) (((a)->vmods_mask1=(((m)>>8)&0xff)),\
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync unsigned char per_key_repeat[XkbPerKeyBitArraySize];
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbAX_AnyFeedback(c) ((c)->enabled_ctrls&XkbAccessXFeedbackMask)
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbAX_NeedFeedback(c, w) (XkbAX_AnyFeedback((c)) && \
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync /* explicit is a C++ reserved word */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync unsigned char *explicit;
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbSMKeyActionsPtr(m, k) (&(m)->acts[(m)->key_acts[(k)]])
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync * Structures and access macros used primarily by clients
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbCMKeyGroupInfo(m, k) ((m)->key_sym_map[(k)].group_info)
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbCMKeyNumGroups(m, k) (XkbNumGroups((m)->key_sym_map[(k)].group_info))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbCMKeyGroupWidth(m, k, g) (XkbCMKeyType((m), (k), (g))->num_levels)
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbCMKeyGroupsWidth(m, k) ((m)->key_sym_map[(k)].width)
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbCMKeyTypeIndex(m, k, g) ((m)->key_sym_map[(k)].kt_index[(g) & 0x3])
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbCMKeyType(m, k, g) (&(m)->types[XkbCMKeyTypeIndex((m), (k), (g))])
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbCMKeyNumSyms(m, k) (XkbCMKeyGroupsWidth((m), (k)) * \
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbCMKeySymsOffset(m, k) ((m)->key_sym_map[(k)].offset)
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbCMKeySymsPtr(m, k) (&(m)->syms[XkbCMKeySymsOffset((m), (k))])
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync * Compatibility structures and access macros
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync /* FIXME: For some reason, interepretation of groups is wildly
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync * different between which being base/latched/locked. */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbIM_IsAuto(i) (!((i)->flags & XkbIM_NoAutomatic) && \
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbIM_InUse(i) ((i)->flags || (i)->which_groups || (i)->which_mods || \
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync * Names for everything
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync * Tie it all together into one big keyboard description
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync unsigned int defined;
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbKeyKeyTypeIndex(d, k, g) (XkbCMKeyTypeIndex((d)->map, (k), (g)))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbKeyKeyType(d, k, g) (XkbCMKeyType((d)->map, (k), (g)))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbKeyGroupWidth(d, k, g) (XkbCMKeyGroupWidth((d)->map, (k), (g)))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbKeyGroupsWidth(d, k) (XkbCMKeyGroupsWidth((d)->map, (k)))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbKeyGroupInfo(d,k) (XkbCMKeyGroupInfo((d)->map,(k)))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbKeyNumGroups(d,k) (XkbCMKeyNumGroups((d)->map,(k)))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbKeyNumSyms(d,k) (XkbCMKeyNumSyms((d)->map,(k)))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbKeySymsPtr(d,k) (XkbCMKeySymsPtr((d)->map,(k)))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbKeySym(d, k, n) (XkbKeySymsPtr((d), (k))[(n)])
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync (XkbKeySym((d), (k), (XkbKeyGroupsWidth((d), (k)) * (g)) + (sl)))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync (XkbKeyHasActions((d), (k)) ? & XkbKeyActionsPtr((d), (k))[(n)] : NULL)
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync (XkbKeyHasActions((d), (k)) ? \
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync XkbKeyAction((d), (k), ((XkbKeyGroupsWidth((d), (k)) * (g)) + (sl))) : \
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbKeyHasActions(d, k) (!!(d)->server->key_acts[(k)])
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbKeyNumActions(d, k) (XkbKeyHasActions((d), (k)) ? \
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbKeyActionsPtr(d, k) (XkbSMKeyActionsPtr((d)->server, (k)))
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbKeycodeInRange(d, k) ((k) >= (d)->min_key_code && \
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbNumKeys(d) ((d)->max_key_code-(d)->min_key_code+1)
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync * The following structures can be used to track changes
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync * to a keyboard device
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync * These data structures are used to construct a keymap from
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync * a set of components or to list components in the server
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync * database.
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync * The following data structures describe and track changes to a
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync * non-keyboard extension device
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbXI_DevHasBtnActs(d) ((d)->num_btns > 0 && (d)->btn_acts)
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbXI_LegalDevBtn(d,b) (XkbXI_DevHasBtnActs(d) && (b) < (d)->num_btns)
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#define XkbXI_DevHasLeds(d) ((d)->num_leds > 0 && (d)->leds)
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync unsigned int defined; /* names or maps changed */
8c3d541c7ee7442f570b22eca3d82808b35b0385vboxsync#endif /* _XKBSTR_H_ */