Edit

kc3-lang/libxkbcommon/scripts/makeheader

Branch :

  • Show log

    Commit

  • Author : Wismill
    Date : 2023-04-30 21:30:36
    Hash : 0e9c2ec9
    Message : Improve the doc of the XKB keymap text format, V1 (#321) - Add table of contents - Add terminology section - (WIP) Add Introduction to the format - Improve the keycode section - Improve the interpret section - Add guide to create and use modifiers - (WIP) Add actions documentation - Add cross-references - Add keysyms header to documentation

  • scripts/makeheader
  • #!/usr/bin/env python
    from __future__ import print_function
    import re
    import os
    
    # expected format:
    # #define XF86XK_FooBar _EVDEVK(0x123) /* some optional comment */
    evdev_pattern = re.compile(r'^#define\s+XF86XK_(?P<name>\w+)\s+_EVDEVK\((?P<value>0x[0-9A-Fa-f]+)\)')
    
    prefix = os.environ.get('X11_HEADERS_PREFIX', '/usr')
    HEADERS = [
        prefix + '/include/X11/keysymdef.h',
        prefix + '/include/X11/XF86keysym.h',
        prefix + '/include/X11/Sunkeysym.h',
        prefix + '/include/X11/DECkeysym.h',
        prefix + '/include/X11/HPkeysym.h',
    ]
    
    print('''#ifndef _XKBCOMMON_KEYSYMS_H
    #define _XKBCOMMON_KEYSYMS_H
    
    /* This file is autogenerated; please do not commit directly. */
    
    /**
     * @file
     * Key symbols (keysyms) definitions.
     */
    
    #define XKB_KEY_NoSymbol                    0x000000  /* Special KeySym */
    ''')
    for path in HEADERS:
        with open(path) as header:
            for line in header:
                if '#ifdef' in line or '#ifndef' in line or '#endif' in line:
                    continue
    
                # Remove #define _OSF_Keysyms and such.
                if '#define _' in line:
                    continue
    
                # Handle a duplicate definition in HPkeysyms.h which kicks in if
                # it's not already defined.
                if 'XK_Ydiaeresis' in line and '0x100000ee' in line:
                    continue
    
                # Replace the xorgproto _EVDEVK macro with the actual value
                # 0x10081000 is the base, the evdev hex code is added to that.
                # We replace to make parsing of the keys later easier.
                match = re.match(evdev_pattern, line)
                if match:
                    value = 0x10081000 + int(match.group('value'), 16)
                    line = re.sub(r'_EVDEVK\(0x([0-9A-Fa-f]+)\)', '{:#x}'.format(value), line)
    
                line = re.sub(r'#define\s*(\w*)XK_', r'#define XKB_KEY_\1', line)
    
                print(line, end='')
    print('\n\n#endif')