Edit

kc3-lang/libxkbcommon/tools/tools-common.h

Branch :

  • Show log

    Commit

  • Author : Pierre Le Marre
    Date : 2025-08-04 12:35:25
    Hash : 29579ad4
    Message : tools: Add --verbose to all tools Added `--verbose` to: - `xkbcli interactive-wayland` - `xkbcli interactive-x11` - `xkbcli compile-compose` - `xkbcli how-to-type`

  • tools/tools-common.h
  • /*
     * Copyright © 2012 Intel Corporation
     * SPDX-License-Identifier: MIT
     *
     * Author: Daniel Stone <daniel@fooishbar.org>
     */
    
    #pragma once
    
    #include "config.h"
    
    #include <assert.h>
    #include <stdbool.h>
    
    /* Don't use compat names in internal code. */
    #define _XKBCOMMON_COMPAT_H
    #include "xkbcommon/xkbcommon.h"
    #include "xkbcommon/xkbcommon-compose.h"
    
    #define ARRAY_SIZE(arr) ((sizeof(arr) / sizeof(*(arr))))
    
    /* Fields that are printed in the interactive tools. */
    enum print_state_options {
        PRINT_LAYOUT = (1u << 0),
        PRINT_UNICODE = (1u << 1),
        PRINT_ALL_FIELDS = ((PRINT_UNICODE << 1) - 1),
        /*
         * Fields that can be hidden with the option --short.
         * NOTE: If this value is modified, remember to update the documentation of
         *       the --short option in the corresponding tools.
         */
        PRINT_VERBOSE_ONE_LINE_FIELDS = (PRINT_LAYOUT | PRINT_UNICODE),
        PRINT_VERBOSE = (1u << 2),
        PRINT_UNILINE = (1u << 3),
        DEFAULT_PRINT_OPTIONS = PRINT_ALL_FIELDS | PRINT_VERBOSE | PRINT_UNILINE
    };
    
    void
    print_modifiers_encodings(struct xkb_keymap *keymap);
    void
    print_keys_modmaps(struct xkb_keymap *keymap);
    
    void
    tools_enable_verbose_logging(struct xkb_context *ctx);
    
    void
    tools_print_keycode_state(const char *prefix,
                              struct xkb_state *state,
                              struct xkb_compose_state *compose_state,
                              xkb_keycode_t keycode,
                              enum xkb_key_direction direction,
                              enum xkb_consumed_mode consumed_mode,
                              enum print_state_options options);
    
    void
    tools_print_state_changes(const char *prefix, struct xkb_state *state,
                              enum xkb_state_component changed,
                              enum print_state_options options);
    
    void
    tools_disable_stdin_echo(void);
    
    void
    tools_enable_stdin_echo(void);
    
    const char *
    select_backend(const char *wayland, const char *x11, const char *fallback);
    
    int
    tools_exec_command(const char *prefix, int argc, const char **argv);
    
    bool
    is_pipe_or_regular_file(int fd);
    
    FILE*
    tools_read_stdin(void);
    
    #ifdef _WIN32
    #define setenv(varname, value, overwrite) _putenv_s((varname), (value))
    #define unsetenv(varname) _putenv_s(varname, "")
    #endif