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
|
/*
* Copyright (C) 2022-2022 The DOSBox Staging Team
* Copyright (C) 2002-2021 The DOSBox 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_H
#define DOSBOX_MOUSE_H
#include "dosbox.h"
#include <regex>
#include <string>
#include <vector>
// ***************************************************************************
// Initialization, configuration
// ***************************************************************************
void MOUSE_Init(Section *);
void MOUSE_AddConfigSection(const config_ptr_t &);
// ***************************************************************************
// Data types
// ***************************************************************************
enum class MouseInterfaceId : uint8_t {
DOS, // emulated DOS mouse driver
PS2, // PS/2 mouse (this includes VMware mouse protocol)
COM1, // serial mouse
COM2,
COM3,
COM4,
First = DOS,
Last = COM4,
None = UINT8_MAX
};
constexpr uint8_t num_mouse_interfaces = static_cast<uint8_t>(MouseInterfaceId::Last) +
1;
enum class MouseMapStatus : uint8_t {
HostPointer,
Mapped, // single physical mouse mapped to emulated port
Disconnected, // physical mouse used to be mapped, but got unplugged
Disabled
};
// ***************************************************************************
// Notifications from external subsystems - all should go via these methods
// ***************************************************************************
void MOUSE_EventMoved(const float x_rel, const float y_rel,
const uint16_t x_abs, const uint16_t y_abs);
void MOUSE_EventMoved(const float x_rel, const float y_rel,
const MouseInterfaceId device_id);
void MOUSE_EventButton(const uint8_t idx, const bool pressed);
void MOUSE_EventButton(const uint8_t idx, const bool pressed,
const MouseInterfaceId device_id);
void MOUSE_EventWheel(const int16_t w_rel);
void MOUSE_EventWheel(const int16_t w_rel, const MouseInterfaceId device_id);
void MOUSE_NotifyBooting();
void MOUSE_SetConfigSeamless(const bool seamless);
void MOUSE_SetConfigNoMouse();
void MOUSE_NewScreenParams(const uint16_t clip_x, const uint16_t clip_y,
const uint16_t res_x, const uint16_t res_y,
const bool fullscreen, const uint16_t x_abs,
const uint16_t y_abs);
// ***************************************************************************
// Information for the GFX subsystem
// ***************************************************************************
bool MOUSE_IsUsingSeamlessDriver(); // if driver with seamless pointer support
// is running
bool MOUSE_IsUsingSeamlessSetting(); // if user selected seamless mode is in effect
// ***************************************************************************
// BIOS mouse interface for PS/2 mouse
// ***************************************************************************
bool MOUSEBIOS_Enable();
bool MOUSEBIOS_Disable();
void MOUSEBIOS_SetCallback(const uint16_t pseg, const uint16_t pofs);
void MOUSEBIOS_Reset();
bool MOUSEBIOS_SetPacketSize(const uint8_t packet_size);
bool MOUSEBIOS_SetSampleRate(const uint8_t rate_id);
void MOUSEBIOS_SetScaling21(const bool enable);
bool MOUSEBIOS_SetResolution(const uint8_t res_id);
uint8_t MOUSEBIOS_GetProtocol();
uint8_t MOUSEBIOS_GetStatus();
uint8_t MOUSEBIOS_GetResolution();
uint8_t MOUSEBIOS_GetSampleRate();
// ***************************************************************************
// DOS mouse driver
// ***************************************************************************
void MOUSEDOS_BeforeNewVideoMode();
void MOUSEDOS_AfterNewVideoMode(const bool setmode);
// ***************************************************************************
// MOUSECTL.COM / GUI configurator interface
// ***************************************************************************
class MouseInterface;
class MousePhysical;
class MouseInterfaceInfoEntry final {
public:
bool IsEmulated() const;
bool IsMapped() const;
bool IsMapped(const uint8_t device_idx) const;
bool IsMappedDeviceDisconnected() const;
MouseInterfaceId GetInterfaceId() const;
MouseMapStatus GetMapStatus() const;
const std::string &GetMappedDeviceName() const;
int16_t GetSensitivityX() const; // -999 to +999
int16_t GetSensitivityY() const; // -999 to +999
uint16_t GetMinRate() const; // 10-500, 0 for none
uint16_t GetRate() const; // current rate, 10-500, 0 for N/A
private:
friend class MouseInterface;
MouseInterfaceInfoEntry(const MouseInterfaceId interface_id);
const uint8_t interface_idx;
const MouseInterface &Interface() const;
const MousePhysical &MappedPhysical() const;
};
class MousePhysicalInfoEntry final {
public:
bool IsMapped() const;
bool IsDeviceDisconnected() const;
const std::string &GetDeviceName() const;
private:
friend class ManyMouseGlue;
MousePhysicalInfoEntry(const uint8_t idx);
const uint8_t idx;
const MousePhysical &Physical() const;
};
class MouseControlAPI final {
public:
// Always destroy the object once it is not needed anymore
// (configuration tool finishes it's job) and we are returning
// to normal code execution!
MouseControlAPI();
~MouseControlAPI();
// Empty list = performs operation on all emulated interfaces
typedef std::vector<MouseInterfaceId> ListIDs;
// Do not use the references after object gets destroyed
const std::vector<MouseInterfaceInfoEntry> &GetInfoInterfaces() const;
const std::vector<MousePhysicalInfoEntry> &GetInfoPhysical();
static bool IsNoMouseMode();
static bool CheckInterfaces(const ListIDs &list_ids);
static bool PatternToRegex(const std::string &pattern, std::regex ®ex);
bool ProbeForMapping(uint8_t &device_id); // For interactive mapping in
// MOUSECTL.COM only!
bool Map(const MouseInterfaceId interface_id, const uint8_t device_idx);
bool Map(const MouseInterfaceId interface_id, const std::regex ®ex);
bool UnMap(const ListIDs &list_ids);
bool OnOff(const ListIDs &list_ids, const bool enable);
bool Reset(const ListIDs &list_ids);
// Valid sensitivity values are from -999 to +999
bool SetSensitivity(const ListIDs &list_ids,
const int16_t sensitivity_x,
const int16_t sensitivity_y);
bool SetSensitivityX(const ListIDs &list_ids, const int16_t sensitivity_x);
bool SetSensitivityY(const ListIDs &list_ids, const int16_t sensitivity_y);
bool ResetSensitivity(const ListIDs &list_ids);
bool ResetSensitivityX(const ListIDs &list_ids);
bool ResetSensitivityY(const ListIDs &list_ids);
static const std::vector<uint16_t> &GetValidMinRateList();
static const std::string &GetValidMinRateStr();
static std::string GetInterfaceNameStr(const MouseInterfaceId interface_id);
bool SetMinRate(const MouseControlAPI::ListIDs &list_ids,
const uint16_t value_hz);
bool ResetMinRate(const MouseControlAPI::ListIDs &list_ids);
private:
MouseControlAPI(const MouseControlAPI &) = delete;
MouseControlAPI &operator=(const MouseControlAPI &) = delete;
};
#endif // DOSBOX_MOUSE_H
|
