File: JSInterface_Hotkey.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 (172 lines) | stat: -rw-r--r-- 5,591 bytes parent folder | download
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
/* Copyright (C) 2022 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 "JSInterface_Hotkey.h"

#include "lib/external_libraries/libsdl.h"
#include "ps/CLogger.h"
#include "ps/ConfigDB.h"
#include "ps/Hotkey.h"
#include "ps/KeyName.h"
#include "scriptinterface/FunctionWrapper.h"
#include "scriptinterface/ScriptConversions.h"

#include <unordered_map>
#include <vector>
#include <set>

/**
 * Convert an unordered map to a JS object, mapping keys to values.
 * Assumes T to have a c_str() method that returns a const char*
 * NB: this is unordered since no particular effort is made to preserve order.
 * TODO: this could be moved to ScriptConversions.cpp if the need arises.
 */
template<typename T, typename U>
static void ToJSVal_unordered_map(const ScriptRequest& rq, JS::MutableHandleValue ret, const std::unordered_map<T, U>& val)
{
	JS::RootedObject obj(rq.cx, JS_NewPlainObject(rq.cx));
	if (!obj)
	{
		ret.setUndefined();
		return;
	}
	for (const std::pair<const T, U>& item : val)
	{
		JS::RootedValue el(rq.cx);
		Script::ToJSVal<U>(rq, &el, item.second);
		JS_SetProperty(rq.cx, obj, item.first.c_str(), el);
	}
	ret.setObject(*obj);
}

template<>
void Script::ToJSVal<std::unordered_map<std::string, std::vector<std::vector<std::string>>>>(const ScriptRequest& rq, JS::MutableHandleValue ret, const std::unordered_map<std::string, std::vector<std::vector<std::string>>>& val)
{
	ToJSVal_unordered_map(rq, ret, val);
}

template<>
void Script::ToJSVal<std::unordered_map<std::string, std::string>>(const ScriptRequest& rq, JS::MutableHandleValue ret, const std::unordered_map<std::string, std::string>& val)
{
	ToJSVal_unordered_map(rq, ret, val);
}

namespace
{
/**
 * @return a (js) object mapping hotkey name (from cfg files) to a list ofscancode names
 */
JS::Value GetHotkeyMap(const ScriptRequest& rq)
{
	JS::RootedValue hotkeyMap(rq.cx);

	std::unordered_map<std::string, std::vector<std::vector<std::string>>> hotkeys;
	for (const std::pair<const SDL_Scancode_, KeyMapping>& key : g_HotkeyMap)
		for (const SHotkeyMapping& mapping : key.second)
		{
			std::vector<std::string> keymap;
			if (key.first != UNUSED_HOTKEY_CODE)
				keymap.push_back(FindScancodeName(static_cast<SDL_Scancode>(key.first)));
			for (const SKey& secondary_key : mapping.requires)
				keymap.push_back(FindScancodeName(static_cast<SDL_Scancode>(secondary_key.code)));
			// If keymap is empty (== unused) or size 1, push the combination.
			// Otherwise, all permutations of the combination will exist, so pick one using an arbitrary order.
			if (keymap.size() < 2 || keymap[0] < keymap[1])
				hotkeys[mapping.name].emplace_back(keymap);
		}
	Script::ToJSVal(rq, &hotkeyMap, hotkeys);

	return hotkeyMap;
}

/**
 * @return a (js) object mapping scancode names to their locale-dependent name.
 */
JS::Value GetScancodeKeyNames(const ScriptRequest& rq)
{
	JS::RootedValue obj(rq.cx);
	std::unordered_map<std::string, std::string> map;

	// Get the name of all scancodes.
	// This is slightly wasteful but should be fine overall, they are dense.
	for (int i = 0; i < MOUSE_LAST; ++i)
		map[FindScancodeName(static_cast<SDL_Scancode>(i))] = FindKeyName(static_cast<SDL_Scancode>(i));
	Script::ToJSVal(rq, &obj, map);

	return obj;
}

void ReloadHotkeys()
{
	UnloadHotkeys();
	LoadHotkeys(g_ConfigDB);
}

JS::Value GetConflicts(const ScriptRequest& rq, JS::HandleValue combination)
{
	std::vector<std::string> keys;
	if (!Script::FromJSVal(rq, combination, keys))
	{
		LOGERROR("Invalid hotkey combination");
		return JS::NullValue();
	}

	if (keys.empty())
		return JS::NullValue();

	// Pick a random code as a starting point of the hotkeys (they are all equivalent).
	SDL_Scancode_ startCode = FindScancode(keys.back());

	std::unordered_map<SDL_Scancode_, KeyMapping>::const_iterator it = g_HotkeyMap.find(startCode);
	if (it == g_HotkeyMap.end())
		return JS::NullValue();

	// Create a sorted vector with the remaining keys.
	keys.pop_back();

	std::set<SKey> codes;
	for (const std::string& key : keys)
		codes.insert(SKey{ FindScancode(key) });

	std::vector<CStr> conflicts;
	// This isn't very efficient, but we shouldn't iterate too many hotkeys
	// since we at least have one matching key.
	for (const SHotkeyMapping& keymap : it->second)
	{
		std::set<SKey> match(keymap.requires.begin(), keymap.requires.end());
		if (codes == match)
			conflicts.emplace_back(keymap.name);
	}
	if (conflicts.empty())
		return JS::NullValue();

	JS::RootedValue ret(rq.cx);
	Script::ToJSVal(rq, &ret, conflicts);
	return ret;
}
}

void JSI_Hotkey::RegisterScriptFunctions(const ScriptRequest& rq)
{
	ScriptFunction::Register<&HotkeyIsPressed>(rq, "HotkeyIsPressed");
	ScriptFunction::Register<&GetHotkeyMap>(rq, "GetHotkeyMap");
	ScriptFunction::Register<&GetScancodeKeyNames>(rq, "GetScancodeKeyNames");
	ScriptFunction::Register<&ReloadHotkeys>(rq, "ReloadHotkeys");
	ScriptFunction::Register<&GetConflicts>(rq, "GetConflicts");
}