src/text.h

   1 /*
   2  * Copyright 2009  Dan Nicholson
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  18  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  19  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  20  *
  21  * Except as contained in this notice, the names of the authors or their
  22  * institutions shall not be used in advertising or otherwise to promote the
  23  * sale, use or other dealings in this Software without prior written
  24  * authorization from the authors.
  25  */
  26
  27 #ifndef TEXT_H
  28 #define TEXT_H
  29
  30 #include "xkb-priv.h"
  31
  32 typedef struct {
  33     const char *name;
  34     unsigned int value;
  35 } LookupEntry;
  36
  37 bool
  38 LookupString(const LookupEntry tab[], const char *string,
  39               unsigned int *value_rtrn);
  40
  41 const char *
  42 LookupValue(const LookupEntry tab[], unsigned int value);
  43
  44 extern const LookupEntry ctrlMaskNames[];
  45 extern const LookupEntry modComponentMaskNames[];
  46 extern const LookupEntry groupComponentMaskNames[];
  47 extern const LookupEntry groupMaskNames[];
  48 extern const LookupEntry groupNames[];
  49 extern const LookupEntry levelNames[];
  50 extern const LookupEntry buttonNames[];
  51 extern const LookupEntry useModMapValueNames[];
  52 extern const LookupEntry actionTypeNames[];
  53 extern const LookupEntry symInterpretMatchMaskNames[];
  54
  55 const char *
  56 VModMaskText(struct xkb_keymap *keymap, xkb_mod_mask_t cmask);
  57
  58 xkb_mod_index_t
  59 ModNameToIndex(const char *name);
  60
  61 const char *
  62 ModIndexToName(xkb_mod_index_t ndx);
  63
  64 const char *
  65 ModIndexText(xkb_mod_index_t ndx);
  66
  67 const char *
  68 ModMaskText(xkb_mod_mask_t mask);
  69
  70 const char *
  71 ActionTypeText(unsigned type);
  72
  73 const char *
  74 KeysymText(xkb_keysym_t sym);
  75
  76 const char *
  77 KeyNameText(const char name[XkbKeyNameLength]);
  78
  79 const char *
  80 SIMatchText(unsigned type);
  81
  82 #endif /* TEXT_H */