fix mod size confusion
[platform/upstream/libxkbcommon.git] / include / X11 / extensions / XKBcommon.h
index 2881458..5b6d02c 100644 (file)
@@ -25,18 +25,43 @@ sale, use or other dealings in this Software without prior written
 authorization from the authors.
 */
 
+/************************************************************
+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.
+
+********************************************************/
+
+
 #ifndef _XKBCOMMON_H_
 #define _XKBCOMMON_H_
 
 #include <stdint.h>
 #include <stdio.h>
 #include <X11/Xfuncproto.h>
+#include <X11/Xmd.h>
 #include <X11/extensions/XKBstrcommon.h>
 #include <X11/extensions/XKBrulescommon.h>
 
-#define KeySym CARD32
-#define Atom CARD32
-
 /* Action structures used in the server */
 
 #define XkbcAnyActionDataSize 18
@@ -48,8 +73,8 @@ typedef struct _XkbcAnyAction {
 typedef struct _XkbcModAction {
     unsigned char   type;
     uint8_t         flags;
+    uint8_t         real_mods;
     uint32_t        mask;
-    uint32_t        real_mods;
     uint32_t        vmods;
 } XkbcModAction;
 
@@ -65,19 +90,19 @@ typedef struct _XkbcISOAction {
     int16_t         group;
     uint32_t        mask;
     uint32_t        vmods;
-    uint32_t        real_mods;
+    uint8_t         real_mods;
     uint8_t         affect;
 } XkbcISOAction;
 
 typedef struct _XkbcCtrlsAction {
     unsigned char   type;
-    unsigned char   flags;
+    uint8_t         flags;
     uint32_t        ctrls;
 } XkbcCtrlsAction;
 
 typedef struct _XkbcDeviceBtnAction {
     unsigned char   type;
-    unsigned char   flags;
+    uint8_t         flags;
     uint16_t        device;
     uint16_t        button;
     uint8_t         count;
@@ -121,17 +146,27 @@ typedef union _XkbcAction {
     XkbPtrAction             ptr; /* XXX delete for DeviceValuator */
     XkbPtrBtnAction          btn; /* XXX delete for DeviceBtn */
     XkbMessageAction         msg; /* XXX just delete */
-    unsigned char           type;
+    unsigned char            type;
 } XkbcAction;
 
+typedef struct _XkbcKeyType {
+    XkbModsRec              mods;
+    unsigned char           num_levels;
+    unsigned char           map_count;
+    XkbKTMapEntryPtr        map;
+    XkbModsPtr              preserve;
+    CARD32                  name;
+    CARD32                 *level_names;
+} XkbcKeyTypeRec, *XkbcKeyTypePtr;
+
 typedef struct _XkbcSymInterpretRec {
     CARD32          sym;
     unsigned char   flags;
     unsigned char   match;
-    unsigned char   mods;
-    unsigned char   virtual_mod;
-    XkbcAnyAction    act;
-} XkbcSymInterpretRec,*XkbcSymInterpretPtr;
+    uint8_t         mods; /* XXX real or virt? */
+    uint32_t        virtual_mod;
+    XkbcAnyAction   act;
+} XkbcSymInterpretRec, *XkbcSymInterpretPtr;
 
 typedef struct _XkbcCompatMapRec {
     XkbcSymInterpretPtr      sym_interpret;
@@ -143,7 +178,7 @@ typedef struct _XkbcCompatMapRec {
 typedef struct _XkbcClientMapRec {
     unsigned char            size_types;
     unsigned char            num_types;
-    XkbKeyTypePtr            types;
+    XkbcKeyTypePtr           types;
 
     unsigned short           size_syms;
     unsigned short           num_syms;
@@ -172,6 +207,265 @@ typedef struct _XkbcServerMapRec {
     uint32_t            *vmodmap;
 } XkbcServerMapRec, *XkbcServerMapPtr;
 
+typedef struct _XkbcNamesRec {
+    CARD32            keycodes;
+    CARD32            geometry;
+    CARD32            symbols;
+    CARD32            types;
+    CARD32            compat;
+    CARD32            vmods[XkbNumVirtualMods];
+    CARD32            indicators[XkbNumIndicators];
+    CARD32            groups[XkbNumKbdGroups];
+    XkbKeyNamePtr     keys;
+    XkbKeyAliasPtr    key_aliases;
+    CARD32           *radio_groups;
+    CARD32            phys_symbols;
+
+    unsigned char     num_keys;
+    unsigned char     num_key_aliases;
+    unsigned short    num_rg;
+} XkbcNamesRec, *XkbcNamesPtr;
+
+typedef        struct _XkbcProperty {
+       char    *name;
+       char    *value;
+} XkbcPropertyRec, *XkbcPropertyPtr;
+
+typedef struct _XkbcColor {
+       unsigned int    pixel;
+       char *          spec;
+} XkbcColorRec, *XkbcColorPtr;
+
+typedef        struct _XkbcPoint {
+       short   x;
+       short   y;
+} XkbcPointRec, *XkbcPointPtr;
+
+typedef struct _XkbcBounds {
+       short   x1,y1;
+       short   x2,y2;
+} XkbcBoundsRec, *XkbcBoundsPtr;
+#define        XkbBoundsWidth(b)       (((b)->x2)-((b)->x1))
+#define        XkbBoundsHeight(b)      (((b)->y2)-((b)->y1))
+
+typedef struct _XkbcOutline {
+       unsigned short  num_points;
+       unsigned short  sz_points;
+       unsigned short  corner_radius;
+       XkbcPointPtr    points;
+} XkbcOutlineRec, *XkbcOutlinePtr;
+
+typedef struct _XkbcShape {
+       CARD32           name;
+       unsigned short   num_outlines;
+       unsigned short   sz_outlines;
+       XkbcOutlinePtr   outlines;
+       XkbcOutlinePtr   approx;
+       XkbcOutlinePtr   primary;
+       XkbcBoundsRec    bounds;
+} XkbcShapeRec, *XkbcShapePtr;
+#define        XkbOutlineIndex(s,o)    ((int)((o)-&(s)->outlines[0]))
+
+typedef struct _XkbcShapeDoodad {
+       CARD32           name;
+       unsigned char    type;
+       unsigned char    priority;
+       short            top;
+       short            left;
+       short            angle;
+       unsigned short   color_ndx;
+       unsigned short   shape_ndx;
+} XkbcShapeDoodadRec, *XkbcShapeDoodadPtr;
+#define        XkbShapeDoodadColor(g,d)        (&(g)->colors[(d)->color_ndx])
+#define        XkbShapeDoodadShape(g,d)        (&(g)->shapes[(d)->shape_ndx])
+#define        XkbSetShapeDoodadColor(g,d,c)   ((d)->color_ndx= (c)-&(g)->colors[0])
+#define        XkbSetShapeDoodadShape(g,d,s)   ((d)->shape_ndx= (s)-&(g)->shapes[0])
+
+typedef struct _XkbcTextDoodad {
+       CARD32           name;
+       unsigned char    type;
+       unsigned char    priority;
+       short            top;
+       short            left;
+       short            angle;
+       short            width;
+       short            height;
+       unsigned short   color_ndx;
+       char *           text;
+       char *           font;
+} XkbcTextDoodadRec, *XkbcTextDoodadPtr;
+#define        XkbTextDoodadColor(g,d) (&(g)->colors[(d)->color_ndx])
+#define        XkbSetTextDoodadColor(g,d,c)    ((d)->color_ndx= (c)-&(g)->colors[0])
+
+typedef struct _XkbcIndicatorDoodad {
+       CARD32           name;
+       unsigned char    type;
+       unsigned char    priority;
+       short            top;
+       short            left;
+       short            angle;
+       unsigned short   shape_ndx;
+       unsigned short   on_color_ndx;
+       unsigned short   off_color_ndx;
+} XkbcIndicatorDoodadRec, *XkbcIndicatorDoodadPtr;
+#define        XkbIndicatorDoodadShape(g,d)    (&(g)->shapes[(d)->shape_ndx])
+#define        XkbIndicatorDoodadOnColor(g,d)  (&(g)->colors[(d)->on_color_ndx])
+#define        XkbIndicatorDoodadOffColor(g,d) (&(g)->colors[(d)->off_color_ndx])
+#define        XkbSetIndicatorDoodadOnColor(g,d,c) \
+                               ((d)->on_color_ndx= (c)-&(g)->colors[0])
+#define        XkbSetIndicatorDoodadOffColor(g,d,c) \
+                               ((d)->off_color_ndx= (c)-&(g)->colors[0])
+#define        XkbSetIndicatorDoodadShape(g,d,s) \
+                               ((d)->shape_ndx= (s)-&(g)->shapes[0])
+
+typedef struct _XkbcLogoDoodad {
+       CARD32           name;
+       unsigned char    type;
+       unsigned char    priority;
+       short            top;
+       short            left;
+       short            angle;
+       unsigned short   color_ndx;
+       unsigned short   shape_ndx;
+       char *           logo_name;
+} XkbcLogoDoodadRec, *XkbcLogoDoodadPtr;
+#define        XkbLogoDoodadColor(g,d)         (&(g)->colors[(d)->color_ndx])
+#define        XkbLogoDoodadShape(g,d)         (&(g)->shapes[(d)->shape_ndx])
+#define        XkbSetLogoDoodadColor(g,d,c)    ((d)->color_ndx= (c)-&(g)->colors[0])
+#define        XkbSetLogoDoodadShape(g,d,s)    ((d)->shape_ndx= (s)-&(g)->shapes[0])
+
+typedef struct _XkbcAnyDoodad {
+       CARD32           name;
+       unsigned char    type;
+       unsigned char    priority;
+       short            top;
+       short            left;
+       short            angle;
+} XkbcAnyDoodadRec, *XkbcAnyDoodadPtr;
+
+typedef union _XkbcDoodad {
+       XkbcAnyDoodadRec        any;
+       XkbcShapeDoodadRec      shape;
+       XkbcTextDoodadRec       text;
+       XkbcIndicatorDoodadRec  indicator;
+       XkbcLogoDoodadRec       logo;
+} XkbcDoodadRec, *XkbcDoodadPtr;
+
+#define        XkbUnknownDoodad        0
+#define        XkbOutlineDoodad        1
+#define        XkbSolidDoodad          2
+#define        XkbTextDoodad           3
+#define        XkbIndicatorDoodad      4
+#define        XkbLogoDoodad           5
+
+typedef struct _XkbcKey {
+       XkbKeyNameRec    name;
+       short            gap;
+       unsigned char    shape_ndx;
+       unsigned char    color_ndx;
+} XkbcKeyRec, *XkbcKeyPtr;
+#define        XkbKeyShape(g,k)        (&(g)->shapes[(k)->shape_ndx])
+#define        XkbKeyColor(g,k)        (&(g)->colors[(k)->color_ndx])
+#define        XkbSetKeyShape(g,k,s)   ((k)->shape_ndx= (s)-&(g)->shapes[0])
+#define        XkbSetKeyColor(g,k,c)   ((k)->color_ndx= (c)-&(g)->colors[0])
+
+typedef struct _XkbRow {
+       short           top;
+       short           left;
+       unsigned short  num_keys;
+       unsigned short  sz_keys;
+       int             vertical;
+       XkbcKeyPtr      keys;
+       XkbcBoundsRec   bounds;
+} XkbcRowRec, *XkbcRowPtr;
+
+typedef struct _XkbcSection {
+       CARD32           name;
+       unsigned char    priority;
+       short            top;
+       short            left;
+       unsigned short   width;
+       unsigned short   height;
+       short            angle;
+       unsigned short   num_rows;
+       unsigned short   num_doodads;
+       unsigned short   num_overlays;
+       unsigned short   sz_rows;
+       unsigned short   sz_doodads;
+       unsigned short   sz_overlays;
+       XkbcRowPtr       rows;
+       XkbcDoodadPtr    doodads;
+       XkbcBoundsRec    bounds;
+       struct _XkbOverlay *overlays;
+} XkbcSectionRec, *XkbcSectionPtr;
+
+typedef        struct _XkbcOverlayKey {
+       XkbKeyNameRec   over;
+       XkbKeyNameRec   under;
+} XkbcOverlayKeyRec, *XkbcOverlayKeyPtr;
+
+typedef struct _XkbOverlayRow {
+       unsigned short          row_under;
+       unsigned short          num_keys;
+       unsigned short          sz_keys;
+       XkbcOverlayKeyPtr       keys;
+} XkbcOverlayRowRec, *XkbcOverlayRowPtr;
+
+typedef struct _XkbOverlay {
+       CARD32                  name;
+       XkbcSectionPtr          section_under;
+       unsigned short          num_rows;
+       unsigned short          sz_rows;
+       XkbcOverlayRowPtr       rows;
+       XkbcBoundsPtr           bounds;
+} XkbcOverlayRec, *XkbcOverlayPtr;
+
+typedef struct _XkbcGeometry {
+       CARD32           name;
+       unsigned short   width_mm;
+       unsigned short   height_mm;
+       char *           label_font;
+       XkbcColorPtr     label_color;
+       XkbcColorPtr     base_color;
+       unsigned short   sz_properties;
+       unsigned short   sz_colors;
+       unsigned short   sz_shapes;
+       unsigned short   sz_sections;
+       unsigned short   sz_doodads;
+       unsigned short   sz_key_aliases;
+       unsigned short   num_properties;
+       unsigned short   num_colors;
+       unsigned short   num_shapes;
+       unsigned short   num_sections;
+       unsigned short   num_doodads;
+       unsigned short   num_key_aliases;
+       XkbcPropertyPtr  properties;
+       XkbcColorPtr     colors;
+       XkbcShapePtr     shapes;
+       XkbcSectionPtr   sections;
+       XkbcDoodadPtr    doodads;
+       XkbKeyAliasPtr   key_aliases;
+} XkbcGeometryRec, *XkbcGeometryPtr;
+#define        XkbGeomColorIndex(g,c)  ((int)((c)-&(g)->colors[0]))
+
+#define        XkbGeomPropertiesMask   (1<<0)
+#define        XkbGeomColorsMask       (1<<1)
+#define        XkbGeomShapesMask       (1<<2)
+#define        XkbGeomSectionsMask     (1<<3)
+#define        XkbGeomDoodadsMask      (1<<4)
+#define        XkbGeomKeyAliasesMask   (1<<5)
+#define        XkbGeomAllMask          (0x3f)
+
+typedef struct _XkbcGeometrySizes {
+       unsigned int    which;
+       unsigned short  num_properties;
+       unsigned short  num_colors;
+       unsigned short  num_shapes;
+       unsigned short  num_sections;
+       unsigned short  num_doodads;
+       unsigned short  num_key_aliases;
+} XkbcGeometrySizesRec, *XkbcGeometrySizesPtr;
+
 /* Common keyboard description structure */
 typedef struct _XkbcDesc {
     unsigned int        defined;
@@ -184,9 +478,9 @@ typedef struct _XkbcDesc {
     XkbcServerMapPtr    server;
     XkbcClientMapPtr    map;
     XkbIndicatorPtr     indicators;
-    XkbNamesPtr         names;
+    XkbcNamesPtr        names;
     XkbcCompatMapPtr    compat;
-    XkbGeometryPtr      geom;
+    XkbcGeometryPtr     geom;
 } XkbcDescRec, *XkbcDescPtr;
 
 _XFUNCPROTOBEGIN
@@ -250,7 +544,4 @@ XkbcStringToKeysym(const char *s);
 
 _XFUNCPROTOEND
 
-#undef KeySym
-#undef Atom
-
 #endif /* _XKBCOMMON_H_ */