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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
/*
* Copyright (C) 2022-2022 The DOSBox Staging Team
*
* This program 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.
*
* This program 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 this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef DOSBOX_MOUSE_INTERFACES_H
#define DOSBOX_MOUSE_INTERFACES_H
#include "mouse_common.h"
#include "../serialport/serialmouse.h"
// ***************************************************************************
// Main mouse module
// ***************************************************************************
void MOUSE_StartupIfReady();
void MOUSE_NotifyDisconnect(const MouseInterfaceId interface_id);
void MOUSE_NotifyFakePS2(); // fake PS/2 event, for VMware protocol support
void MOUSE_NotifyResetDOS();
bool MOUSE_IsCaptured();
void MOUSE_UpdateGFX();
// ***************************************************************************
// DOS mouse driver
// ***************************************************************************
void MOUSEDOS_Init();
void MOUSEDOS_NotifyInputType(const bool new_use_relative,
const bool new_is_input_raw);
void MOUSEDOS_NotifyMinRate(const uint16_t value_hz);
void MOUSEDOS_DrawCursor();
bool MOUSEDOS_HasCallback(const uint8_t mask);
Bitu MOUSEDOS_DoCallback(const uint8_t mask, const MouseButtons12S buttons_12S);
// - needs relative movements
// - understands up to 3 buttons
bool MOUSEDOS_NotifyMoved(const float x_rel, const float y_rel,
const uint32_t x_abs, const uint32_t y_abs);
bool MOUSEDOS_NotifyWheel(const int16_t w_rel);
uint8_t MOUSEDOS_UpdateMoved();
uint8_t MOUSEDOS_UpdateButtons(const MouseButtons12S buttons_12S);
uint8_t MOUSEDOS_UpdateWheel();
// ***************************************************************************
// PS/2 mouse
// ***************************************************************************
void MOUSEPS2_Init();
void MOUSEPS2_UpdateButtonSquish();
void MOUSEPS2_PortWrite(const uint8_t byte);
void MOUSEPS2_UpdatePacket();
bool MOUSEPS2_SendPacket();
// - needs relative movements
// - understands up to 5 buttons in Intellimouse Explorer mode
// - understands up to 3 buttons in other modes
bool MOUSEPS2_NotifyMoved(const float x_rel, const float y_rel);
bool MOUSEPS2_NotifyButton(const MouseButtons12S buttons_12S,
const MouseButtonsAll buttons_all);
bool MOUSEPS2_NotifyWheel(const int16_t w_rel);
// ***************************************************************************
// BIOS mouse interface for PS/2 mouse
// ***************************************************************************
Bitu MOUSEBIOS_DoCallback();
// ***************************************************************************
// VMware protocol extension for PS/2 mouse
// ***************************************************************************
void MOUSEVMM_Init();
void MOUSEVMM_NotifyInputType(const bool new_use_relative,
const bool new_is_input_raw);
void MOUSEVMM_NewScreenParams(const uint32_t x_abs, const uint32_t y_abs);
void MOUSEVMM_Deactivate();
// - needs absolute mouse position
// - understands up to 3 buttons
bool MOUSEVMM_NotifyMoved(const float x_rel, const float y_rel,
const uint32_t x_abs, const uint32_t y_abs);
bool MOUSEVMM_NotifyButton(const MouseButtons12S buttons_12S);
bool MOUSEVMM_NotifyWheel(const int16_t w_rel);
// ***************************************************************************
// Serial mouse
// ***************************************************************************
// - needs relative movements
// - understands up to 3 buttons
// - needs index of button which changed state
// Nothing to declare
// ***************************************************************************
// Base mouse interface
// ***************************************************************************
class MouseInterface {
public:
MouseInterface() = delete;
MouseInterface(const MouseInterface &) = delete;
MouseInterface &operator=(const MouseInterface &) = delete;
static void InitAllInstances();
static MouseInterface *Get(const MouseInterfaceId interface_id);
static MouseInterface *GetDOS();
static MouseInterface *GetPS2();
static MouseInterface *GetSerial(const uint8_t port_id);
virtual void NotifyMoved(MouseEvent &ev, const float x_rel, const float y_rel,
const uint32_t x_abs, const uint32_t y_abs) = 0;
virtual void NotifyButton(MouseEvent &ev, const uint8_t idx,
const bool pressed) = 0;
virtual void NotifyWheel(MouseEvent &ev, const int16_t w_rel) = 0;
void NotifyInterfaceRate(const uint16_t new_rate_hz);
virtual void NotifyBooting();
void NotifyDisconnect();
bool IsMapped() const;
bool IsMapped(const uint8_t device_idx) const;
bool IsEmulated() const;
bool IsUsingEvents() const;
bool IsUsingHostPointer() const;
MouseInterfaceId GetInterfaceId() const;
MouseMapStatus GetMapStatus() const;
uint8_t GetMappedDeviceIdx() const;
int16_t GetSensitivityX() const;
int16_t GetSensitivityY() const;
uint16_t GetMinRate() const;
uint16_t GetRate() const;
bool ConfigMap(const uint8_t device_idx);
void ConfigUnMap();
void ConfigOnOff(const bool enable);
void ConfigReset();
void ConfigSetSensitivity(const int16_t value_x, const int16_t value_y);
void ConfigSetSensitivityX(const int16_t value);
void ConfigSetSensitivityY(const int16_t value);
void ConfigResetSensitivity();
void ConfigResetSensitivityX();
void ConfigResetSensitivityY();
void ConfigSetMinRate(const uint16_t value_hz);
void ConfigResetMinRate();
virtual void UpdateConfig();
virtual void UpdateInputType();
virtual void RegisterListener(CSerialMouse &listener_object);
virtual void UnRegisterListener();
protected:
static constexpr uint8_t idx_host_pointer = UINT8_MAX;
MouseInterface(const MouseInterfaceId interface_id,
const float sensitivity_predefined);
virtual ~MouseInterface() = default;
virtual void Init();
uint8_t GetInterfaceIdx() const;
void SetMapStatus(const MouseMapStatus status,
const uint8_t device_idx = idx_host_pointer);
virtual void UpdateSensitivity();
virtual void UpdateMinRate();
virtual void UpdateRate();
void UpdateButtons(const uint8_t idx, const bool pressed);
void ResetButtons();
bool ChangedButtonsJoined() const;
bool ChangedButtonsSquished() const;
MouseButtonsAll GetButtonsJoined() const;
MouseButtons12S GetButtonsSquished() const;
bool emulated = false;
float sensitivity_coeff_x = 1.0f; // cached combined sensitivity coefficients
float sensitivity_coeff_y = 1.0f; // to reduce amount of multiplications
int16_t sensitivity_user_x = 0;
int16_t sensitivity_user_y = 0;
uint16_t rate_hz = 0;
uint16_t min_rate_hz = 0;
uint16_t interface_rate_hz = 0;
private:
const MouseInterfaceId interface_id = MouseInterfaceId::None;
MouseMapStatus map_status = MouseMapStatus::HostPointer;
uint8_t mapped_idx = idx_host_pointer; // index of mapped physical mouse
MouseButtons12 buttons_12 = 0; // host side buttons 1 (left), 2 (right)
MouseButtons345 buttons_345 = 0; // host side buttons 3 (middle), 4, and 5
MouseButtons12 old_buttons_12 = 0; // pre-update values
MouseButtons345 old_buttons_345 = 0;
float sensitivity_predefined = 1.0f; // hardcoded for the given interface
};
extern std::vector<MouseInterface *> mouse_interfaces;
#endif // DOSBOX_MOUSE_INTERFACES_H
|
