keyboard.h | Explore in Territory

/**************************************************************************/
/*  keyboard.h                                                            */
/**************************************************************************/
/*                         This file is part of:                          */
/*                             GODOT ENGINE                               */
/*                        https://godotengine.org                         */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */
/*                                                                        */
/* 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 OR COPYRIGHT HOLDERS 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.                 */
/**************************************************************************/

#ifndef KEYBOARD_H
#define KEYBOARD_H

#include "core/string/ustring.h"

// Keep the values in this enum in sync with `_keycodes` in `keyboard.cpp`,
// and the bindings in `core_constants.cpp`.
enum class Key { … };

enum class KeyModifierMask { … };

enum class KeyLocation { … };

// To avoid having unnecessary operators, only define the ones that are needed.

constexpr Key operator-(uint32_t a, Key b) { … }

constexpr Key &operator-=(Key &a, int b) { … }

constexpr Key operator+(Key a, int b) { … }

constexpr Key operator+(Key a, Key b) { … }

constexpr Key operator-(Key a, Key b) { … }

constexpr Key operator&(Key a, Key b) { … }

constexpr Key operator|(Key a, Key b) { … }

constexpr Key &operator|=(Key &a, Key b) { … }

constexpr Key &operator|=(Key &a, KeyModifierMask b) { … }

constexpr Key &operator&=(Key &a, KeyModifierMask b) { … }

constexpr Key operator|(Key a, KeyModifierMask b) { … }

constexpr Key operator&(Key a, KeyModifierMask b) { … }

constexpr Key operator+(KeyModifierMask a, Key b) { … }

constexpr Key operator|(KeyModifierMask a, Key b) { … }

constexpr KeyModifierMask operator+(KeyModifierMask a, KeyModifierMask b) { … }

constexpr KeyModifierMask operator|(KeyModifierMask a, KeyModifierMask b) { … }

String keycode_get_string(Key p_code);
bool keycode_has_unicode(Key p_keycode);
Key find_keycode(const String &p_codestr);
const char *find_keycode_name(Key p_keycode);
int keycode_get_count();
int keycode_get_value_by_index(int p_index);
const char *keycode_get_name_by_index(int p_index);

char32_t fix_unicode(char32_t p_char);
Key fix_keycode(char32_t p_char, Key p_key);
Key fix_key_label(char32_t p_char, Key p_key);

#endif // KEYBOARD_H
godot/core/os/keyboard.h
