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