kc3-lang/libxkbcommon/src/text.h

• Show log

  Commit

• Hash : 07b18bde
  Author :
  Date : 2012-08-09T02:33:51
  

  Modernize struct xkb_mods
  
  Currently xkb_mods has the following members:
  - uint8_t real_mods - 8 X11 core mods
  - xkb_mod_mask_t vmods - 16 virtual mods, zero-based index
  - xkb_mod_mask_t mask - the computed effective *real* modifier mask,
    basically a cache for the first two which is:
    real_mods | real mods computed from vmods
  
  Our API acts on masks which combine the real_mods and vmods into a
  single value, which is:
  8 first bits real mods | 16 next bits virtual mods
  (XkbNumModifiers = 8, XkbNumVirtualMods = 16). This is also the format
  which ResolveVModMask uses (which is where all the modifier masks really
  "come from", e.g. "Shift+Lock+Level5" -> xkb_mod_mask_t).
  
  What the code does now after getting the mask from ResolveVModMask, is
  to break it into real part and virtual part and store them seperately,
  and then join them back together when the effective mask is calculated.
  
  This is all pretty useless work. We change xkb_mods to the following:
  - xkb_mod_mask_t mods - usually what ResolveVModMask returns
  - xkb_mod_mask_t mask - the computed mask cache
  And try to consistently use the word "mods" for the original,
  non-effective mods and mask for the effective mods (which can only
  contain real mods for now, because things break otherwise).
  
  The separation is also made clearer. The effective masks are computed by
  UpdateModifiersFromCompat after all the sections have been compiled;
  before this the mask field is never touched; after this (i.e. map.c and
  state.c) the original mods field is never touched. This single execption
  to this rule is keymap-dump.c: it needs to print out only the original
  modifiers, not computed ones. This is also the reason why we actually
  keep two fields instead keeping one and modifying it in place.
  
  The next logical step is probably to turn the real mods into vmods
  themselves, and get rid of the distinction entirely (in a compatible
  way).
  
  Signed-off-by: Ran Benita <ran234@gmail.com>
  

Download

• src/text.h

• /*
   * Copyright 2009  Dan Nicholson
   *
   * Permission is hereby granted, free of charge, to any person obtaining a
   * copy of this software and associated documentation files (the "Software"),
   * to deal in the Software without restriction, including without limitation
   * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   * and/or sell copies of the Software, and to permit persons to whom the
   * Software is furnished to do so, subject to the following conditions:
   *
   * The above copyright notice and this permission notice shall be included in
   * all copies or substantial portions of the Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
   * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
   * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
   * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
   *
   * Except as contained in this notice, the names of the authors or their
   * institutions shall not be used in advertising or otherwise to promote the
   * sale, use or other dealings in this Software without prior written
   * authorization from the authors.
   */
  
  #ifndef TEXT_H
  #define TEXT_H
  
  #include "xkb-priv.h"
  
  const char *
  VModMaskText(struct xkb_keymap *keymap, xkb_mod_mask_t cmask);
  
  xkb_mod_index_t
  ModNameToIndex(const char *name);
  
  const char *
  ModIndexToName(xkb_mod_index_t ndx);
  
  const char *
  ModIndexText(xkb_mod_index_t ndx);
  
  const char *
  ModMaskText(xkb_mod_mask_t mask);
  
  const char *
  FileTypeText(enum xkb_file_type type);
  
  const char *
  ActionTypeText(unsigned type);
  
  const char *
  KeysymText(xkb_keysym_t sym);
  
  const char *
  KeyNameText(const char name[XkbKeyNameLength]);
  
  const char *
  SIMatchText(unsigned type);
  
  #endif /* TEXT_H */
  

Download