keyboard_control.h File Reference

#include "utils/macros.h"
#include <cinttypes>
#include <cstddef>
#include <memory>

Include dependency graph for keyboard_control.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	keyboard_control

Macros
#define	K_ALT(x)
#define	K_CTRL(x)
#define	K_CTRL_DOWN   0x1b5b313b3542LL
#define	K_CTRL_UP   0x1b5b313b3541LL
#define	K_DOWN   0x1b5b42
#define	K_LEFT   0x1b5b44
#define	K_PGDOWN   0x1b5b367e
#define	K_PGUP   0x1b5b357e
#define	K_RIGHT   0x1b5b43
#define	K_UP   0x1b5b41
#define	MAX_KEYCODE_NAME_LEN   8

Functions
EXTERN_C void	get_keycode_name (int64_t ch, char *buf, size_t buflen) __attribute__((used))
EXTERN_C bool	keycontrol_register_key (struct module *sender_mod, int64_t key, const char *message, const char *description) __attribute__((used))
	Registers callback message for given key.
EXTERN_C void	keycontrol_send_key (struct module *root, int64_t key) __attribute__((used))
EXTERN_C void	restore_old_tio (void)

Detailed Description

Author

Martin Pulec pulec.nosp@m.@ces.nosp@m.net.c.nosp@m.z

Definition in file keyboard_control.h.

Macro Definition Documentation

K_ALT

#define K_ALT

(

x

)

Value:

('\033' << 8 | (x))

Definition at line 79 of file keyboard_control.h.

Referenced by display_gl_process_key(), get_ansi_code(), and translate_glfw_to_ug().

K_CTRL

#define K_CTRL

(

x

)

Value:

(1 + ((x) >= 'A' && (x) <= 'Z' ? (x) - 'A' + 'a' : (x)) - 'a')

Definition at line 76 of file keyboard_control.h.

Referenced by keyboard_control::impl::run(), translate_glfw_to_ug(), translate_sdl_key_to_ug(), and keyboard_control::impl::usage().

K_CTRL_DOWN

#define K_CTRL_DOWN   0x1b5b313b3542LL

Definition at line 78 of file keyboard_control.h.

Referenced by display_gl_process_key(), get_keycode_representation(), and translate_glfw_to_ug().

K_CTRL_UP

#define K_CTRL_UP   0x1b5b313b3541LL

Definition at line 77 of file keyboard_control.h.

Referenced by display_gl_process_key(), get_keycode_representation(), and translate_glfw_to_ug().

K_DOWN

#define K_DOWN   0x1b5b42

Definition at line 71 of file keyboard_control.h.

Referenced by get_keycode_representation(), playback_register_keyboard_ctl(), translate_glfw_to_ug(), and translate_sdl_key_to_ug().

K_LEFT

#define K_LEFT   0x1b5b44

Definition at line 73 of file keyboard_control.h.

Referenced by get_keycode_representation(), playback_register_keyboard_ctl(), translate_glfw_to_ug(), and translate_sdl_key_to_ug().

K_PGDOWN

#define K_PGDOWN   0x1b5b367e

Definition at line 75 of file keyboard_control.h.

Referenced by get_keycode_representation(), playback_register_keyboard_ctl(), translate_glfw_to_ug(), and translate_sdl_key_to_ug().

K_PGUP

#define K_PGUP   0x1b5b357e

Definition at line 74 of file keyboard_control.h.

Referenced by get_keycode_representation(), playback_register_keyboard_ctl(), translate_glfw_to_ug(), and translate_sdl_key_to_ug().

K_RIGHT

#define K_RIGHT   0x1b5b43

Definition at line 72 of file keyboard_control.h.

Referenced by get_keycode_representation(), playback_register_keyboard_ctl(), translate_glfw_to_ug(), and translate_sdl_key_to_ug().

K_UP

#define K_UP   0x1b5b41

Definition at line 70 of file keyboard_control.h.

Referenced by get_keycode_representation(), playback_register_keyboard_ctl(), translate_glfw_to_ug(), and translate_sdl_key_to_ug().

MAX_KEYCODE_NAME_LEN

#define MAX_KEYCODE_NAME_LEN   8

Definition at line 81 of file keyboard_control.h.

Referenced by glfw_key_callback().

Function Documentation

get_keycode_name()

EXTERN_C void get_keycode_name	(	int64_t	ch,
		char *	buf,
		size_t	buflen )

Definition at line 1063 of file keyboard_control.cpp.

                                                            {
        if (buflen == 0) {
                return;
        }
        string name = get_keycode_representation(ch);
        strncpy(buf, name.c_str(), buflen - 1);
        buf[buflen - 1] = '\0';
}

References get_keycode_representation(), and name.

Referenced by gl_show_help(), and glfw_key_callback().

Here is the call graph for this function:

keycontrol_register_key()

EXTERN_C bool keycontrol_register_key	(	struct module *	receiver_mod,
		int64_t	key,
		const char *	message,
		const char *	description )

Registers callback message for given key.

message_universal message type is always sent

Parameters

[in]	sender_mod	module that should receive the message for key
[in]	message	text that will be passed back to receiver_mod if key was pressed
[in]	description	optional decription that will be displayed in keyboard control help (may be NULL)

Definition at line 1041 of file keyboard_control.cpp.

                                                                                                                     {
        assert(strchr(message, '#') == nullptr && (description == nullptr || strchr(description, '#') == nullptr));
        char receiver_path[1024];
        if (!module_get_path_str(receiver_mod, receiver_path, sizeof receiver_path)) {
                log_msg(LOG_LEVEL_ERROR, MOD_NAME "Cannot format format path for sender!\n");
                return false;
        }
        struct msg_universal *m = (struct msg_universal *) new_message(sizeof(struct msg_universal));
        if (description == nullptr) {
                description = message;
        }
        snprintf(m->text, sizeof m->text, "map #%" PRId64 " %s %s#%s", key, receiver_path, message, description);
        struct response *r = send_message_sync(get_root_module(receiver_mod), "keycontrol", (struct message *) m, 100,  SEND_MESSAGE_FLAG_QUIET | SEND_MESSAGE_FLAG_NO_STORE);
        if (response_get_status(r) != RESPONSE_OK) {
                log_msg(LOG_LEVEL_ERROR, MOD_NAME "Cannot register keyboard control (error %d)!\n", response_get_status(r));
                free_response(r);
                return false;
        }
        free_response(r);
        return true;
}

References description, free_response(), get_root_module(), key, LOG_LEVEL_ERROR, log_msg(), MOD_NAME, module_get_path_str(), new_message(), response_get_status(), RESPONSE_OK, SEND_MESSAGE_FLAG_NO_STORE, SEND_MESSAGE_FLAG_QUIET, send_message_sync(), and msg_universal::text.

Referenced by display_gl_init(), display_sdl2_init(), display_sdl_init(), and playback_register_keyboard_ctl().

Here is the call graph for this function:

keycontrol_send_key()

EXTERN_C void keycontrol_send_key	(	struct module *	root,
		int64_t	key )

Todo

all UG core functions should have the 'used' attribute

Definition at line 1024 of file keyboard_control.cpp.

                                                           {
        struct msg_universal *m = (struct msg_universal *) new_message(sizeof(struct msg_universal));
        snprintf(m->text, sizeof m->text, "press %" PRId64, key);
        struct response *r = send_message_sync(root, "keycontrol", (struct message *) m, 100,  SEND_MESSAGE_FLAG_QUIET | SEND_MESSAGE_FLAG_NO_STORE);
        if (response_get_status(r) != RESPONSE_OK) {
                log_msg(LOG_LEVEL_ERROR, MOD_NAME "Cannot set key to keycontrol (error %d)!\n", response_get_status(r));
        }
        free_response(r);
}

References free_response(), key, LOG_LEVEL_ERROR, log_msg(), MOD_NAME, new_message(), response_get_status(), RESPONSE_OK, SEND_MESSAGE_FLAG_NO_STORE, SEND_MESSAGE_FLAG_QUIET, send_message_sync(), and msg_universal::text.

Referenced by display_sdl2_run(), and glfw_key_callback().

Here is the call graph for this function:

restore_old_tio()

EXTERN_C void restore_old_tio

(

void

)

Definition at line 188 of file keyboard_control.cpp.

{
#ifdef HAVE_TERMIOS_H
        struct sigaction sa, sa_old;
        memset(&sa, 0, sizeof sa);
        sa.sa_handler = SIG_IGN;
        sigemptyset(&sa.sa_mask);
        sigaction(SIGTTOU, &sa, &sa_old);
        /* set the new settings immediately */
        /* restore the former settings */
        tcsetattr(STDIN_FILENO,TCSANOW,&old_tio);
        sigaction(SIGTTOU, &sa_old, NULL);
#endif
}

Referenced by crash_signal_handler(), keyboard_control::impl::read_command(), and keyboard_control::impl::start().