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
|
// Copyright 2005-2016 The Mumble Developers. All rights reserved.
// Use of this source code is governed by a BSD-style license
// that can be found in the LICENSE file at the root of the
// Mumble source tree or at <https://www.mumble.info/LICENSE>.
/* Copyright (C) 2015, Jordan J Klassen <forivall@gmail.com>
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
- Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
- 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.
- Neither the name of the Mumble Developers 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 COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS 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 FOUNDATION 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.
*/
/* SPECIFICATION
* The code interfacing with the Logitech G-Keys DLL was implemented using the
* following spec:
*
* The G-keys DLL lives in
* "C:\Program Files\Logitech Gaming Software\SDK\G-key\x64\LogitechGkey.dll" for x64 and
* "C:\Program Files\Logitech Gaming Software\SDK\G-key\x86\LogitechGkey.dll" for x86.
*
* Its location can also be read from the registry, using the following keys:
*
* x86:
* "HKEY_CLASSES_ROOT\CLSID\{7bded654-f278-4977-a20f-6e72a0d07859}\ServerBinary"
*
* x64:
* "HKEY_CLASSES_ROOT\Wow6432Node\CLSID\{7bded654-f278-4977-a20f-6e72a0d07859}\ServerBinary"
*
* The registry keys are needed if a user installed the Logitech Gaming
* Software in a non-standard location.
*
* The DLL has an init function, it's called "LogiGkeyInit". It takes a
* pointer, but the parameter must always be NULL. The function returns a BOOL
* as a status code.
*
* The DLL also has a shutdown function, called "LogiGkeyShutdown". It takes
* no parameters and does not return anything.
*
* You can poll for button states with the DLL using the functions
* "LogiGkeyIsMouseButtonPressed" and "LogiGkeyIsKeyboardGkeyPressed".
*
* The function "LogiGkeyIsMouseButtonPressed" takes a single int parameter, a
* button number. Mouse button numbers run from 6 up to and including 20. The
* function returns a BOOL that is true if the button is pressed, and false if
* not.
*
* The function "LogiGkeyIsKeyboardGkeyPressed" takes two int parameters, a
* button number and a mode number. Keyboard button numbers run from 1 up to
* and including 29. The mode number can 1, 2 or 3. The mode checks the button
* state in a specific mode. Typically, one queries all buttons for all modes,
* so one ends up with 29*3 calls to the function. The function returns a BOOL
* that is true if the button in the given mode is pressed, and false if not.
*
* There are also two functions, "LogiGkeyGetMouseButtonString" and
* "LogiGkeyGetKeyboardGkeyString". They take the same parameters as the
* polling functions above, but do not check whether the button is pressed or
* not. Instead, they return the name of the button being queried as a pointer
* to a NUL-terminated array of wchar_t's. Presumably, the pointer will be
* NULL if the name cannot be retrieved or translated.
*/
/* USAGE
* In order to use the gkeys on a logitech keyboard, any user must have the
* Logitech Gaming Software version 8.55+ installed on their computer. Then
* (re)start mumble. When mumble initializes the library, the LGS (Logitech
* Gaming Software) will create a profile called "mumble", featuring the mumble
* icon. In LGS, right click this icon, and select either "Set as Default" or
* "Set as Persistent". (See "What are persistent and default profiles?" in the
* LGS help by clicking on the "?" icon on the LGS window, or at
* http://www.logitech.com/assets/51813/3/lgs-guide.pdf). If mumble is not set
* as the default or persistent profile, then your keys will not be active
* unless mumble is the active window.
*/
#include "mumble_pch.hpp"
#include "GKey.h"
#ifdef Q_CC_GNU
#define RESOLVE(var) { var = reinterpret_cast<__typeof__(var)>(qlLogiGkey.resolve(#var)); bValid = bValid && (var != NULL); }
#else
#define RESOLVE(var) { * reinterpret_cast<void **>(&var) = static_cast<void *>(qlLogiGkey.resolve(#var)); bValid = bValid && (var != NULL); }
#endif
const QUuid GKeyLibrary::quMouse = QUuid(QString::fromLatin1(GKEY_MOUSE_GUID));
const QUuid GKeyLibrary::quKeyboard = QUuid(QString::fromLatin1(GKEY_KEYBOARD_GUID));
GKeyLibrary::GKeyLibrary()
{
QStringList alternatives;
HKEY key = NULL;
DWORD type = 0;
WCHAR wcLocation[510];
DWORD len = 510;
if (RegOpenKeyEx(GKEY_LOGITECH_DLL_REG_HKEY, GKEY_LOGITECH_DLL_REG_PATH, NULL, KEY_READ, &key) == ERROR_SUCCESS) {
LONG err = RegQueryValueEx(key, L"", NULL, &type, reinterpret_cast<LPBYTE>(wcLocation), &len);
if (err == ERROR_SUCCESS && type == REG_SZ) {
QString qsLocation = QString::fromUtf16(reinterpret_cast<ushort *>(wcLocation), len / 2);
qWarning("GKeyLibrary: Found ServerBinary with libLocation = \"%s\", len = %d", qPrintable(qsLocation), len);
alternatives << qsLocation;
} else {
qWarning("GKeyLibrary: Error looking up ServerBinary (Error: 0x%x, Type: 0x%x, len: %d)", err, type, len);
}
}
alternatives << QString::fromLatin1(GKEY_LOGITECH_DLL_DEFAULT_LOCATION);
foreach(const QString &lib, alternatives) {
qlLogiGkey.setFileName(lib);
if (qlLogiGkey.load()) {
bValid = true;
break;
}
}
RESOLVE(LogiGkeyInit);
RESOLVE(LogiGkeyShutdown);
RESOLVE(LogiGkeyIsMouseButtonPressed);
RESOLVE(LogiGkeyIsKeyboardGkeyPressed);
RESOLVE(LogiGkeyGetMouseButtonString);
RESOLVE(LogiGkeyGetKeyboardGkeyString);
if (bValid)
bValid = LogiGkeyInit(NULL);
}
GKeyLibrary::~GKeyLibrary() {
if (LogiGkeyShutdown != NULL)
LogiGkeyShutdown();
}
bool GKeyLibrary::isValid() const {
return bValid;
}
bool GKeyLibrary::isMouseButtonPressed(int button) {
return LogiGkeyIsMouseButtonPressed(button);
}
bool GKeyLibrary::isKeyboardGkeyPressed(int key, int mode) {
return LogiGkeyIsKeyboardGkeyPressed(key, mode);
}
QString GKeyLibrary::getMouseButtonString(int button) {
return QString::fromWCharArray(LogiGkeyGetMouseButtonString(button));
}
QString GKeyLibrary::getKeyboardGkeyString(int key, int mode) {
return QString::fromWCharArray(LogiGkeyGetKeyboardGkeyString(key, mode));
}
|
