mirror of
https://github.com/outbackdingo/UltraGrid.git
synced 2026-04-07 17:05:37 +00:00
363729fbcd
- fixed few warnings (UTF-8 code 0 UB, read fail) - keycodes can be up to 64-bit (some places used int)
129 lines
4.1 KiB
C++
129 lines
4.1 KiB
C++
/**
|
|
* @file keyboard_control.h
|
|
* @author Martin Pulec <pulec@cesnet.cz>
|
|
*/
|
|
/*
|
|
* Copyright (c) 2015-2019 CESNET, z. s. p. o.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, is permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* 3. Neither the name of CESNET nor the names of its contributors may be
|
|
* used to endorse or promote products derived from this software without
|
|
* specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING,
|
|
* BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
|
|
* AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
|
|
* EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
|
|
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
|
|
* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
|
|
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef keyboard_control_h_
|
|
#define keyboard_control_h_
|
|
|
|
#include "host.h"
|
|
#include "module.h"
|
|
|
|
#ifdef __cplusplus
|
|
|
|
#include <cinttypes>
|
|
#include <ctime>
|
|
#include <condition_variable>
|
|
#include <map>
|
|
#include <mutex>
|
|
#include <queue>
|
|
#include <set>
|
|
#include <string>
|
|
#include <thread>
|
|
#include <utility>
|
|
|
|
#ifdef HAVE_TERMIOS_H
|
|
#include <termios.h>
|
|
#endif
|
|
|
|
class keyboard_control {
|
|
public:
|
|
keyboard_control(struct module *parent);
|
|
~keyboard_control();
|
|
void start();
|
|
void stop();
|
|
|
|
static void msg_received_func(struct module *);
|
|
void msg_received();
|
|
|
|
private:
|
|
void read_command(bool multiple);
|
|
void execute_command(const char *command);
|
|
bool exec_local_command(const char *commnad);
|
|
void exec_external_commands(const char *commnads);
|
|
|
|
void load_config_map();
|
|
|
|
int64_t get_next_key();
|
|
void info();
|
|
void run();
|
|
void signal();
|
|
void usage();
|
|
|
|
struct module m_mod;
|
|
|
|
std::thread m_keyboard_thread;
|
|
struct module *m_root, *m_parent;
|
|
#ifdef HAVE_TERMIOS_H
|
|
int m_event_pipe[2];
|
|
#else
|
|
std::condition_variable m_cv;
|
|
#endif
|
|
bool m_should_exit;
|
|
std::queue<int64_t> m_pressed_keys;
|
|
bool m_started;
|
|
bool m_locked_against_changes;
|
|
std::time_t m_start_time;
|
|
|
|
std::set<int64_t> guarded_keys;
|
|
std::map<int64_t, std::pair<std::string, std::string> > key_mapping; // user defined - key, command, name
|
|
std::mutex m_lock;
|
|
};
|
|
|
|
#endif // __cplusplus
|
|
|
|
// values are byte represenations of escape sequences (without ESC itself)
|
|
#define K_UP 0x1b5b41
|
|
#define K_DOWN 0x1b5b42
|
|
#define K_RIGHT 0x1b5b43
|
|
#define K_LEFT 0x1b5b44
|
|
#define K_PGUP 0x1b5b357e
|
|
#define K_PGDOWN 0x1b5b367e
|
|
#define K_CTRL(x) (1 + ((x) >= 'A' && (x) <= 'Z' ? (x) - 'A' + 'a' : (x)) - 'a')
|
|
#define K_CTRL_UP 0x1b5b313b3541LL
|
|
#define K_CTRL_DOWN 0x1b5b313b3542LL
|
|
#define K_ALT(x) ('\e' << 8 | (x)) /// exception - include ESC, otherwise Alt-a would become 'a'
|
|
|
|
#define MAX_KEYCODE_NAME_LEN 8
|
|
|
|
// attribute used guaranties that the symbol is present even if not referenced (modular build)
|
|
/// @todo all UG core functions should have the 'used' attribute
|
|
EXTERN_C void keycontrol_send_key(struct module *root, int64_t key) ATTRIBUTE(used);
|
|
EXTERN_C bool keycontrol_register_key(struct module *sender_mod, int64_t key, const char *message, const char *description) ATTRIBUTE(used);
|
|
EXTERN_C void get_keycode_name(int64_t ch, char *buf, size_t buflen) ATTRIBUTE(used);
|
|
|
|
#endif // keyboard_control_h_
|
|
|