File: CHotkeyPicker.cpp

package info (click to toggle)
0ad 0.0.26-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 130,460 kB
  • sloc: cpp: 261,824; ansic: 198,392; javascript: 19,067; python: 14,557; sh: 7,629; perl: 4,072; xml: 849; makefile: 741; java: 533; ruby: 229; php: 190; pascal: 30; sql: 21; tcl: 4
file content (193 lines) | stat: -rw-r--r-- 5,882 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
/* Copyright (C) 2021 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 "gui/ObjectBases/IGUIObject.h"
#include "lib/timer.h"
#include "ps/CLogger.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 Script::ToJSVal(const ScriptRequest& rq, JS::MutableHandleValue ret, const CHotkeyPicker::Key& val)
{
	Script::ToJSVal(rq, ret, val.scancodeName);
}

// Unused, but JSVAL_VECTOR requires it.
template<> bool Script::FromJSVal(const ScriptRequest&, const JS::HandleValue, CHotkeyPicker::Key&)
{
	LOGWARNING("FromJSVal<CHotkeyPicker>: Not implemented");
	return false;
}

JSVAL_VECTOR(CHotkeyPicker::Key);

CHotkeyPicker::CHotkeyPicker(CGUI& pGUI) : IGUIObject(pGUI), m_TimeToCombination(this, "time_to_combination", 1.f)
{
	// 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)
{
	ScriptRequest rq(*m_pGUI.GetScriptInterface());

	JS::RootedValueArray<1> args(rq.cx);
	JS::RootedValue keys(rq.cx);
	Script::ToJSVal(rq, &keys, m_KeysPressed);
	args[0].set(keys);
	ScriptEvent(event, args);
}

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::PreemptEvent(const SDL_Event_* ev)
{
	switch (ev->ev.type)
	{
	// Handle the same mouse events that hotkeys handle
	case SDL_MOUSEBUTTONDOWN:
	case SDL_MOUSEBUTTONUP:
	case SDL_MOUSEWHEEL:
	{
		SDL_Scancode scancode;

		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)
				scancode = static_cast<SDL_Scancode>(MOUSE_BASE + (int)ev->ev.button.button + 2);
			else
				scancode = static_cast<SDL_Scancode>(MOUSE_BASE + (int)ev->ev.button.button);
		}
		else
		{
			if (ev->ev.wheel.y > 0)
				scancode = static_cast<SDL_Scancode>(MOUSE_WHEELUP);
			else if (ev->ev.wheel.y < 0)
				scancode = static_cast<SDL_Scancode>(MOUSE_WHEELDOWN);
			else if (ev->ev.wheel.x > 0)
				scancode = static_cast<SDL_Scancode>(MOUSE_X2);
			else if (ev->ev.wheel.x < 0)
				scancode = static_cast<SDL_Scancode>(MOUSE_X1);
			else
				return IN_HANDLED;
		}
		// Don't handle keys and mouse together except for modifiers.
		m_KeysPressed.erase(std::remove_if(m_KeysPressed.begin(), m_KeysPressed.end(), [](const Key& k) {
			return static_cast<int>(k.code) < UNIFIED_SHIFT || static_cast<int>(k.code) >= UNIFIED_LAST; } ), m_KeysPressed.end());
		m_KeysPressed.emplace_back(Key{scancode, FindScancodeName(scancode)});
		// For mouse events, assume we immediately want to return.
		FireEvent(EventNameCombination);

		return IN_HANDLED;
	}
	case SDL_KEYDOWN:
	case SDL_KEYUP:
	{
		SDL_Scancode scancode = ev->ev.key.keysym.scancode;

		// Don't handle caps-lock, it doesn't really work in-game and it's a weird hotkey.
		if (scancode == SDL_SCANCODE_CAPSLOCK)
			return IN_PASS;

		if (scancode == SDL_SCANCODE_LSHIFT || scancode == SDL_SCANCODE_RSHIFT)
			scancode = static_cast<SDL_Scancode>(UNIFIED_SHIFT);
		else if (scancode == SDL_SCANCODE_LCTRL || scancode == SDL_SCANCODE_RCTRL)
			scancode = static_cast<SDL_Scancode>(UNIFIED_CTRL);
		else if (scancode == SDL_SCANCODE_LALT || scancode == SDL_SCANCODE_RALT)
			scancode = static_cast<SDL_Scancode>(UNIFIED_ALT);
		else if (scancode == SDL_SCANCODE_LGUI || scancode == SDL_SCANCODE_RGUI)
			scancode = static_cast<SDL_Scancode>(UNIFIED_SUPER);

		if (ev->ev.type == SDL_KEYDOWN)
		{
			std::vector<Key>::const_iterator it = \
				std::find_if(m_KeysPressed.begin(), m_KeysPressed.end(), [&scancode](Key& k) { return k.code == scancode; });
			// Can happen if multiple keys are mapped the same.
			if (it != m_KeysPressed.end())
				return IN_HANDLED;
			m_KeysPressed.emplace_back(Key{scancode, FindScancodeName(scancode)});
		}
		else
		{
			std::vector<Key>::const_iterator it = \
				std::find_if(m_KeysPressed.begin(), m_KeysPressed.end(), [&scancode](Key& k) { return k.code == scancode; });
			// 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;
	}
	}
}