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 "xkb-priv.h"
  31 #include "ast.h"
  32
  33 bool
  34 XkbParseFile(struct xkb_context *ctx, FILE *file, const char *file_name,
  35              XkbFile **out);
  36
  37 bool
  38 XkbParseString(struct xkb_context *context, const char *string,
  39                const char *file_name, XkbFile **out);
  40
  41 void
  42 FreeXkbFile(XkbFile *file);
  43
  44 XkbFile *
  45 XkbFileFromComponents(struct xkb_context *ctx,
  46                       struct xkb_component_names *kkctgs);
  47
  48 bool
  49 CompileKeycodes(XkbFile *file, struct xkb_keymap *keymap,
  50                 enum merge_mode merge);
  51
  52 bool
  53 CompileKeyTypes(XkbFile *file, struct xkb_keymap *keymap,
  54                 enum merge_mode merge);
  55
  56 bool
  57 CompileCompatMap(XkbFile *file, struct xkb_keymap *keymap,
  58                  enum merge_mode merge);
  59
  60 bool
  61 CompileSymbols(XkbFile *file, struct xkb_keymap *keymap,
  62                enum merge_mode merge);
  63
  64 bool
  65 UpdateModifiersFromCompat(struct xkb_keymap *keymap);
  66
  67 bool
  68 LookupKeysym(const char *str, xkb_keysym_t *sym_rtrn);
  69
  70 const char *
  71 StmtTypeToString(enum stmt_type type);
  72
  73 /***====================================================================***/
  74
  75 static inline bool
  76 ReportNotArray(struct xkb_keymap *keymap, const char *type, const char *field,
  77                const char *name)
  78 {
  79     log_err(keymap->ctx,
  80             "The %s %s field is not an array; "
  81             "Ignoring illegal assignment in %s\n",
  82             type, field, name);
  83     return false;
  84 }
  85
  86 static inline bool
  87 ReportShouldBeArray(struct xkb_keymap *keymap, const char *type,
  88                     const char *field, const char *name)
  89 {
  90     log_err(keymap->ctx,
  91             "Missing subscript for %s %s; "
  92             "Ignoring illegal assignment in %s\n",
  93             type, field, name);
  94     return false;
  95 }
  96
  97 static inline bool
  98 ReportBadType(struct xkb_context *ctx, const char *type, const char *field,
  99               const char *name, const char *wanted)
 100 {
 101     log_err(ctx, "The %s %s field must be a %s; "
 102             "Ignoring illegal assignment in %s\n",
 103             type, field, wanted, name);
 104     return false;
 105 }
 106
 107 static inline bool
 108 ReportBadField(struct xkb_keymap *keymap, const char *type, const char *field,
 109                const char *name)
 110 {
 111     log_err(keymap->ctx,
 112             "Unknown %s field %s in %s; "
 113             "Ignoring assignment to unknown field in %s\n",
 114             type, field, name, name);
 115     return false;
 116 }
 117
 118 #endif