src/xkbcomp/xkbcomp-priv.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 XKBCOMP_PRIV_H
  28 #define XKBCOMP_PRIV_H
  29
  30 #include "xkbcomp.h"
  31 #include "text.h"
  32
  33 extern bool
  34 ProcessIncludeFile(struct xkb_context *ctx, IncludeStmt *stmt,
  35                    enum xkb_file_type file_type, XkbFile **file_rtrn,
  36                    enum merge_mode *merge_rtrn);
  37
  38 struct xkb_key *
  39 FindNamedKey(struct xkb_keymap *keymap, unsigned long name,
  40              bool use_aliases, bool create, xkb_keycode_t start_from);
  41
  42 extern bool
  43 FindKeyNameForAlias(struct xkb_keymap *keymap, unsigned long lname,
  44                     unsigned long *real_name);
  45
  46 extern bool
  47 UpdateModifiersFromCompat(struct xkb_keymap *keymap);
  48
  49 xkb_mod_mask_t
  50 VModsToReal(struct xkb_keymap *keymap, xkb_mod_mask_t vmodmask);
  51
  52 const char *
  53 StmtTypeToString(enum stmt_type type);
  54
  55 static inline unsigned long
  56 KeyNameToLong(const char name[XkbKeyNameLength])
  57 {
  58     return
  59         (((unsigned long)name[0]) << 24) |
  60         (((unsigned long)name[1]) << 16) |
  61         (((unsigned long)name[2]) << 8)  |
  62         (((unsigned long)name[3]) << 0);
  63 }
  64
  65 static inline void
  66 LongToKeyName(unsigned long val, char name[XkbKeyNameLength])
  67 {
  68     name[0] = ((val >> 24) & 0xff);
  69     name[1] = ((val >> 16) & 0xff);
  70     name[2] = ((val >> 8) & 0xff);
  71     name[3] = ((val >> 0) & 0xff);
  72 }
  73
  74 static inline const char *
  75 LongKeyNameText(unsigned long val)
  76 {
  77     char buf[XkbKeyNameLength];
  78     LongToKeyName(val, buf);
  79     return KeyNameText(buf);
  80 }
  81
  82 static inline bool
  83 ReportNotArray(struct xkb_keymap *keymap, const char *type, const char *field,
  84                const char *name)
  85 {
  86     log_err(keymap->ctx,
  87             "The %s %s field is not an array; "
  88             "Ignoring illegal assignment in %s\n",
  89             type, field, name);
  90     return false;
  91 }
  92
  93 static inline bool
  94 ReportShouldBeArray(struct xkb_keymap *keymap, const char *type,
  95                     const char *field, const char *name)
  96 {
  97     log_err(keymap->ctx,
  98             "Missing subscript for %s %s; "
  99             "Ignoring illegal assignment in %s\n",
 100             type, field, name);
 101     return false;
 102 }
 103
 104 static inline bool
 105 ReportBadType(struct xkb_keymap *keymap, const char *type, const char *field,
 106               const char *name, const char *wanted)
 107 {
 108     log_err(keymap->ctx,
 109             "The %s %s field must be a %s; "
 110             "Ignoring illegal assignment in %s\n",
 111             type, field, wanted, name);
 112     return false;
 113 }
 114
 115 static inline bool
 116 ReportBadField(struct xkb_keymap *keymap, const char *type, const char *field,
 117                const char *name)
 118 {
 119     log_err(keymap->ctx,
 120             "Unknown %s field %s in %s; "
 121             "Ignoring assignment to unknown field in %s\n",
 122             type, field, name, name);
 123     return false;
 124 }
 125
 126 #endif /* XKBCOMP_PRIV_H */