Differential D2814 Diff 13098 source/gui/ObjectTypes/CHotkeyPicker.cpp

Changeset View

Standalone View

source/gui/ObjectTypes/CHotkeyPicker.cpp

This file was added.

				/* Copyright (C) 2020 Wildfire Games.
				* This file is part of 0 A.D.
				*
				* 0 A.D. is free software: you can redistribute it and/or modify
				* it under the terms of the GNU General Public License as published by
				* the Free Software Foundation, either version 2 of the License, or
				* (at your option) any later version.
				*
				* 0 A.D. is distributed in the hope that it will be useful,
				* but WITHOUT ANY WARRANTY; without even the implied warranty of
				* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
				* GNU General Public License for more details.
				*
				* You should have received a copy of the GNU General Public License
				* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
				*/

				#include "precompiled.h"

				#include "CHotkeyPicker.h"

				#include "lib/timer.h"
				#include "ps/Hotkey.h"
				#include "ps/KeyName.h"
				#include "scriptinterface/ScriptConversions.h"

				const CStr CHotkeyPicker::EventNameCombination = "Combination";
				const CStr CHotkeyPicker::EventNameKeyChange = "KeyChange";

				// Don't send the scancode, JS doesn't care.
				template<> void ScriptInterface::ToJSVal(JSContext *cx, JS::MutableHandleValue ret, const CHotkeyPicker::Key& val)
				{
				ScriptInterface::ToJSVal(cx, ret, CStr(val.name).FromUTF8());
				}

				// Provided only because JSVAL_VECTOR requires it.
				template<> bool ScriptInterface::FromJSVal(JSContext *cx, const JS::HandleValue val, CHotkeyPicker::Key& ret)
				{
				return ScriptInterface::FromJSVal(cx, val, ret.name);
				}

				JSVAL_VECTOR(CHotkeyPicker::Key);

				CHotkeyPicker::CHotkeyPicker(CGUI& pGUI) : IGUIObject(pGUI), m_TimeToCombination(1.f)
				{
				RegisterSetting("time_to_combination", m_TimeToCombination);
				// 8 keys at the same time is probably more than we'll ever need.
				m_KeysPressed.reserve(8);
				}

				CHotkeyPicker::~CHotkeyPicker()
				{
				}

				void CHotkeyPicker::FireEvent(const CStr& event)
				{
				JSContext* cx = m_pGUI.GetScriptInterface()->GetContext();
				JSAutoRequest rq(cx);

				JS::AutoValueArray<1> args(cx);
				JS::RootedValue keys(cx);
				m_pGUI.GetScriptInterface()->ToJSVal(cx, &keys, m_KeysPressed);
				args[0].set(keys);
				ScriptEvent(event, args);
				}

				wraitiiAuthorUnsubmitted Done Inline Actions This isn't very conventional, I could use a free-function come D2768 wraitii: This isn't very conventional, I could use a free-function come D2768
				void CHotkeyPicker::Tick()
				{
				if (m_KeysPressed.size() == 0)
				return;

				double time = timer_Time();
				if (time - m_LastKeyChange < m_TimeToCombination)
				return;

				FireEvent(EventNameCombination);

				return;
				}

				void CHotkeyPicker::HandleMessage(SGUIMessage& Message)
				{
				IGUIObject::HandleMessage(Message);
				switch (Message.type)
				{
				case GUIM_GOT_FOCUS:
				case GUIM_LOST_FOCUS:
				{
				m_KeysPressed.clear();
				m_LastKeyChange = timer_Time();
				break;
				}
				default:
				break;
				}
				}

				InReaction CHotkeyPicker::ManuallyHandleEvent(const SDL_Event_* ev)
				{
				switch (ev->ev.type)
				{
				// Handle the same mouse events that hotkeys handle
				case SDL_MOUSEBUTTONUP:
				case SDL_MOUSEWHEEL:
				{
				SDL_Keycode keyCode;

				if (ev->ev.type != SDL_MOUSEWHEEL)
				{
				// Wait a little bit -> this gets triggered when clicking on a button,
				// but after the button click is processed, thus immediately triggering...
				if (timer_Time()-m_LastKeyChange < 0.2)
				return IN_HANDLED;
				// This is from hotkeyHandler - not sure what it does in all honesty.
				if(ev->ev.button.button >= SDL_BUTTON_X1)
				keyCode = MOUSE_BASE + (int)ev->ev.button.button + 2;
				else
				keyCode = MOUSE_BASE + (int)ev->ev.button.button;
				}
				else
				{
				if (ev->ev.wheel.y > 0)
				keyCode = MOUSE_WHEELUP;
				else if (ev->ev.wheel.y < 0)
				keyCode = MOUSE_WHEELDOWN;
				else if (ev->ev.wheel.x > 0)
				keyCode = MOUSE_X2;
				else if (ev->ev.wheel.x < 0)
				keyCode = MOUSE_X1;
				else
				return IN_HANDLED;
				}
				// Don't handle keys and mouse together
				m_KeysPressed.clear();
				CStr keyName = FindKeyName(keyCode);
				m_KeysPressed.emplace_back(Key{SDL_Scancode{}, keyName});
				// For mouse events, assume we immediately want to return.
				FireEvent(EventNameCombination);

				return IN_HANDLED;
				}
				case SDL_KEYDOWN:
				case SDL_KEYUP:
				{
				SDL_Keycode keyCode = ev->ev.key.keysym.sym;
				if (ev->ev.type == SDL_KEYDOWN)
				{
				std::vector<Key>::const_iterator it = \
				std::find_if(m_KeysPressed.begin(), m_KeysPressed.end(), [&keyCode](Key& k) { return k.code == keyCode; });
				// Can happen if multiple keys are mapped the same.
				if (it != m_KeysPressed.end())
				return IN_HANDLED;
				CStr keyName = FindKeyName(keyCode);
				m_KeysPressed.emplace_back(Key{keyCode, std::move(keyName)});
				}
				else
				{
				std::vector<Key>::const_iterator it = \
				std::find_if(m_KeysPressed.begin(), m_KeysPressed.end(), [&keyCode](Key& k) { return k.code == keyCode; });
				// Might happen if a key was down before this object is created.
				if (it == m_KeysPressed.end())
				return IN_HANDLED;
				m_KeysPressed.erase(it);
				}

				FireEvent(EventNameKeyChange);

				// Register after-JS in case this takes a while (probably not but it doesn't hurt).
				m_LastKeyChange = timer_Time();
				return IN_HANDLED;
				}
				default:
				{
				return IN_PASS;
				}
				}
				}