-
Notifications
You must be signed in to change notification settings - Fork 0
/
PeripheralUtils.h
735 lines (658 loc) · 23.3 KB
/
PeripheralUtils.h
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
/*
* Copyright (C) 2014-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#pragma once
#include "Peripheral.h"
#include <array> // Requires c++11
#include <cstring>
#include <string>
#include <utility>
#include <vector>
#define PERIPHERAL_SAFE_DELETE(x) do { delete (x); (x) = NULL; } while (0)
#define PERIPHERAL_SAFE_DELETE_ARRAY(x) do { delete[] (x); (x) = NULL; } while (0)
namespace kodi
{
namespace addon
{
/*!
* Utility class to manipulate arrays of peripheral types.
*/
template <class THE_CLASS, typename THE_STRUCT>
class PeripheralVector
{
public:
static void ToStructs(const std::vector<THE_CLASS>& vecObjects, THE_STRUCT** pStructs)
{
if (!pStructs)
return;
if (vecObjects.empty())
{
*pStructs = NULL;
}
else
{
(*pStructs) = new THE_STRUCT[vecObjects.size()];
for (unsigned int i = 0; i < vecObjects.size(); i++)
vecObjects.at(i).ToStruct((*pStructs)[i]);
}
}
static void ToStructs(const std::vector<THE_CLASS*>& vecObjects, THE_STRUCT** pStructs)
{
if (!pStructs)
return;
if (vecObjects.empty())
{
*pStructs = NULL;
}
else
{
*pStructs = new THE_STRUCT[vecObjects.size()];
for (unsigned int i = 0; i < vecObjects.size(); i++)
vecObjects.at(i)->ToStruct((*pStructs)[i]);
}
}
static void FreeStructs(unsigned int structCount, THE_STRUCT* structs)
{
if (structs)
{
for (unsigned int i = 0; i < structCount; i++)
THE_CLASS::FreeStruct(structs[i]);
}
PERIPHERAL_SAFE_DELETE_ARRAY(structs);
}
};
/*!
* ADDON::Peripheral
*
* Wrapper class providing peripheral information. Classes can extend
* Peripheral to inherit peripheral properties.
*/
class Peripheral
{
public:
Peripheral(PERIPHERAL_TYPE type = PERIPHERAL_TYPE_UNKNOWN, const std::string& strName = "") :
m_type(type),
m_strName(strName)
{
}
explicit Peripheral(const PERIPHERAL_INFO& info) :
m_type(info.type),
m_strName(info.name ? info.name : ""),
m_vendorId(info.vendor_id),
m_productId(info.product_id),
m_index(info.index)
{
}
virtual ~Peripheral(void) = default;
PERIPHERAL_TYPE Type(void) const { return m_type; }
const std::string& Name(void) const { return m_strName; }
uint16_t VendorID(void) const { return m_vendorId; }
uint16_t ProductID(void) const { return m_productId; }
unsigned int Index(void) const { return m_index; }
// Derived property: VID and PID are 0x0000 if unknown
bool IsVidPidKnown(void) const { return m_vendorId != 0 || m_productId != 0; }
void SetType(PERIPHERAL_TYPE type) { m_type = type; }
void SetName(const std::string& strName) { m_strName = strName; }
void SetVendorID(uint16_t vendorId) { m_vendorId = vendorId; }
void SetProductID(uint16_t productId) { m_productId = productId; }
void SetIndex(unsigned int index) { m_index = index; }
void ToStruct(PERIPHERAL_INFO& info) const
{
info.type = m_type;
info.name = new char[m_strName.size() + 1];
info.vendor_id = m_vendorId;
info.product_id = m_productId;
info.index = m_index;
std::strcpy(info.name, m_strName.c_str());
}
static void FreeStruct(PERIPHERAL_INFO& info)
{
PERIPHERAL_SAFE_DELETE_ARRAY(info.name);
}
private:
PERIPHERAL_TYPE m_type;
std::string m_strName;
uint16_t m_vendorId = 0;
uint16_t m_productId = 0;
unsigned int m_index = 0;
};
typedef PeripheralVector<Peripheral, PERIPHERAL_INFO> Peripherals;
/*!
* ADDON::PeripheralEvent
*
* Wrapper class for peripheral events.
*/
class PeripheralEvent
{
public:
PeripheralEvent() = default;
PeripheralEvent(unsigned int peripheralIndex, unsigned int buttonIndex, JOYSTICK_STATE_BUTTON state) :
m_type(PERIPHERAL_EVENT_TYPE_DRIVER_BUTTON),
m_peripheralIndex(peripheralIndex),
m_driverIndex(buttonIndex),
m_buttonState(state)
{
}
PeripheralEvent(unsigned int peripheralIndex, unsigned int hatIndex, JOYSTICK_STATE_HAT state) :
m_type(PERIPHERAL_EVENT_TYPE_DRIVER_HAT),
m_peripheralIndex(peripheralIndex),
m_driverIndex(hatIndex),
m_hatState(state)
{
}
PeripheralEvent(unsigned int peripheralIndex, unsigned int axisIndex, JOYSTICK_STATE_AXIS state) :
m_type(PERIPHERAL_EVENT_TYPE_DRIVER_AXIS),
m_peripheralIndex(peripheralIndex),
m_driverIndex(axisIndex),
m_axisState(state)
{
}
explicit PeripheralEvent(const PERIPHERAL_EVENT& event) :
m_type(event.type),
m_peripheralIndex(event.peripheral_index),
m_driverIndex(event.driver_index),
m_buttonState(event.driver_button_state),
m_hatState(event.driver_hat_state),
m_axisState(event.driver_axis_state),
m_motorState(event.motor_state)
{
}
PERIPHERAL_EVENT_TYPE Type(void) const { return m_type; }
unsigned int PeripheralIndex(void) const { return m_peripheralIndex; }
unsigned int DriverIndex(void) const { return m_driverIndex; }
JOYSTICK_STATE_BUTTON ButtonState(void) const { return m_buttonState; }
JOYSTICK_STATE_HAT HatState(void) const { return m_hatState; }
JOYSTICK_STATE_AXIS AxisState(void) const { return m_axisState; }
JOYSTICK_STATE_MOTOR MotorState(void) const { return m_motorState; }
void SetType(PERIPHERAL_EVENT_TYPE type) { m_type = type; }
void SetPeripheralIndex(unsigned int index) { m_peripheralIndex = index; }
void SetDriverIndex(unsigned int index) { m_driverIndex = index; }
void SetButtonState(JOYSTICK_STATE_BUTTON state) { m_buttonState = state; }
void SetHatState(JOYSTICK_STATE_HAT state) { m_hatState = state; }
void SetAxisState(JOYSTICK_STATE_AXIS state) { m_axisState = state; }
void SetMotorState(JOYSTICK_STATE_MOTOR state) { m_motorState = state; }
void ToStruct(PERIPHERAL_EVENT& event) const
{
event.type = m_type;
event.peripheral_index = m_peripheralIndex;
event.driver_index = m_driverIndex;
event.driver_button_state = m_buttonState;
event.driver_hat_state = m_hatState;
event.driver_axis_state = m_axisState;
event.motor_state = m_motorState;
}
static void FreeStruct(PERIPHERAL_EVENT& event)
{
(void)event;
}
private:
PERIPHERAL_EVENT_TYPE m_type = PERIPHERAL_EVENT_TYPE_NONE;
unsigned int m_peripheralIndex = 0;
unsigned int m_driverIndex = 0;
JOYSTICK_STATE_BUTTON m_buttonState = JOYSTICK_STATE_BUTTON_UNPRESSED;
JOYSTICK_STATE_HAT m_hatState = JOYSTICK_STATE_HAT_UNPRESSED;
JOYSTICK_STATE_AXIS m_axisState = 0.0f;
JOYSTICK_STATE_MOTOR m_motorState = 0.0f;
};
typedef PeripheralVector<PeripheralEvent, PERIPHERAL_EVENT> PeripheralEvents;
/*!
* kodi::addon::Joystick
*
* Wrapper class providing additional joystick information not provided by
* ADDON::Peripheral.
*/
class Joystick : public Peripheral
{
public:
Joystick(const std::string& provider = "", const std::string& strName = "") :
Peripheral(PERIPHERAL_TYPE_JOYSTICK, strName),
m_provider(provider),
m_requestedPort(NO_PORT_REQUESTED)
{
}
Joystick(const Joystick& other)
{
*this = other;
}
explicit Joystick(const JOYSTICK_INFO& info) :
Peripheral(info.peripheral),
m_provider(info.provider ? info.provider : ""),
m_requestedPort(info.requested_port),
m_buttonCount(info.button_count),
m_hatCount(info.hat_count),
m_axisCount(info.axis_count),
m_motorCount(info.motor_count),
m_supportsPowerOff(info.supports_poweroff)
{
}
~Joystick(void) override = default;
Joystick& operator=(const Joystick& rhs)
{
if (this != &rhs)
{
Peripheral::operator=(rhs);
m_provider = rhs.m_provider;
m_requestedPort = rhs.m_requestedPort;
m_buttonCount = rhs.m_buttonCount;
m_hatCount = rhs.m_hatCount;
m_axisCount = rhs.m_axisCount;
m_motorCount = rhs.m_motorCount;
m_supportsPowerOff = rhs.m_supportsPowerOff;
}
return *this;
}
const std::string& Provider(void) const { return m_provider; }
int RequestedPort(void) const { return m_requestedPort; }
unsigned int ButtonCount(void) const { return m_buttonCount; }
unsigned int HatCount(void) const { return m_hatCount; }
unsigned int AxisCount(void) const { return m_axisCount; }
unsigned int MotorCount(void) const { return m_motorCount; }
bool SupportsPowerOff(void) const { return m_supportsPowerOff; }
void SetProvider(const std::string& provider) { m_provider = provider; }
void SetRequestedPort(int requestedPort) { m_requestedPort = requestedPort; }
void SetButtonCount(unsigned int buttonCount) { m_buttonCount = buttonCount; }
void SetHatCount(unsigned int hatCount) { m_hatCount = hatCount; }
void SetAxisCount(unsigned int axisCount) { m_axisCount = axisCount; }
void SetMotorCount(unsigned int motorCount) { m_motorCount = motorCount; }
void SetSupportsPowerOff(bool supportsPowerOff) { m_supportsPowerOff = supportsPowerOff; }
void ToStruct(JOYSTICK_INFO& info) const
{
Peripheral::ToStruct(info.peripheral);
info.provider = new char[m_provider.size() + 1];
info.requested_port = m_requestedPort;
info.button_count = m_buttonCount;
info.hat_count = m_hatCount;
info.axis_count = m_axisCount;
info.motor_count = m_motorCount;
info.supports_poweroff = m_supportsPowerOff;
std::strcpy(info.provider, m_provider.c_str());
}
static void FreeStruct(JOYSTICK_INFO& info)
{
Peripheral::FreeStruct(info.peripheral);
PERIPHERAL_SAFE_DELETE_ARRAY(info.provider);
}
private:
std::string m_provider;
int m_requestedPort;
unsigned int m_buttonCount = 0;
unsigned int m_hatCount = 0;
unsigned int m_axisCount = 0;
unsigned int m_motorCount = 0;
bool m_supportsPowerOff = false;
};
typedef PeripheralVector<Joystick, JOYSTICK_INFO> Joysticks;
/*!
* ADDON::DriverPrimitive
*
* Base class for joystick driver primitives. A driver primitive can be:
*
* 1) a button
* 2) a hat direction
* 3) a semiaxis (either the positive or negative half of an axis)
* 4) a motor
* 5) a keyboard key
* 6) a mouse button
* 7) a relative pointer direction
*
* The type determines the fields in use:
*
* Button:
* - driver index
*
* Hat direction:
* - driver index
* - hat direction
*
* Semiaxis:
* - driver index
* - center
* - semiaxis direction
* - range
*
* Motor:
* - driver index
*
* Key:
* - key code
*
* Mouse button:
* - driver index
*
* Relative pointer direction:
* - relative pointer direction
*/
struct DriverPrimitive
{
protected:
/*!
* \brief Construct a driver primitive of the specified type
*/
DriverPrimitive(JOYSTICK_DRIVER_PRIMITIVE_TYPE type, unsigned int driverIndex) :
m_type(type),
m_driverIndex(driverIndex)
{
}
public:
/*!
* \brief Construct an invalid driver primitive
*/
DriverPrimitive(void) = default;
/*!
* \brief Construct a driver primitive representing a joystick button
*/
static DriverPrimitive CreateButton(unsigned int buttonIndex)
{
return DriverPrimitive(JOYSTICK_DRIVER_PRIMITIVE_TYPE_BUTTON, buttonIndex);
}
/*!
* \brief Construct a driver primitive representing one of the four direction
* arrows on a dpad
*/
DriverPrimitive(unsigned int hatIndex, JOYSTICK_DRIVER_HAT_DIRECTION direction) :
m_type(JOYSTICK_DRIVER_PRIMITIVE_TYPE_HAT_DIRECTION),
m_driverIndex(hatIndex),
m_hatDirection(direction)
{
}
/*!
* \brief Construct a driver primitive representing the positive or negative
* half of an axis
*/
DriverPrimitive(unsigned int axisIndex, int center, JOYSTICK_DRIVER_SEMIAXIS_DIRECTION direction, unsigned int range) :
m_type(JOYSTICK_DRIVER_PRIMITIVE_TYPE_SEMIAXIS),
m_driverIndex(axisIndex),
m_center(center),
m_semiAxisDirection(direction),
m_range(range)
{
}
/*!
* \brief Construct a driver primitive representing a motor
*/
static DriverPrimitive CreateMotor(unsigned int motorIndex)
{
return DriverPrimitive(JOYSTICK_DRIVER_PRIMITIVE_TYPE_MOTOR, motorIndex);
}
/*!
* \brief Construct a driver primitive representing a key on a keyboard
*/
DriverPrimitive(std::string keycode) :
m_type(JOYSTICK_DRIVER_PRIMITIVE_TYPE_KEY),
m_keycode(std::move(keycode))
{
}
/*!
* \brief Construct a driver primitive representing a mouse button
*/
static DriverPrimitive CreateMouseButton(JOYSTICK_DRIVER_MOUSE_INDEX buttonIndex)
{
return DriverPrimitive(JOYSTICK_DRIVER_PRIMITIVE_TYPE_MOUSE_BUTTON, static_cast<unsigned int>(buttonIndex));
}
/*!
* \brief Construct a driver primitive representing one of the four
* direction in which a relative pointer can move
*/
DriverPrimitive(JOYSTICK_DRIVER_RELPOINTER_DIRECTION direction) :
m_type(JOYSTICK_DRIVER_PRIMITIVE_TYPE_RELPOINTER_DIRECTION),
m_relPointerDirection(direction)
{
}
explicit DriverPrimitive(const JOYSTICK_DRIVER_PRIMITIVE& primitive) :
m_type(primitive.type)
{
switch (m_type)
{
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_BUTTON:
{
m_driverIndex = primitive.button.index;
break;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_HAT_DIRECTION:
{
m_driverIndex = primitive.hat.index;
m_hatDirection = primitive.hat.direction;
break;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_SEMIAXIS:
{
m_driverIndex = primitive.semiaxis.index;
m_center = primitive.semiaxis.center;
m_semiAxisDirection = primitive.semiaxis.direction;
m_range = primitive.semiaxis.range;
break;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_MOTOR:
{
m_driverIndex = primitive.motor.index;
break;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_KEY:
{
m_keycode = primitive.key.keycode;
break;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_MOUSE_BUTTON:
{
m_driverIndex = primitive.mouse.button;
break;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_RELPOINTER_DIRECTION:
{
m_relPointerDirection = primitive.relpointer.direction;
break;
}
default:
break;
}
}
JOYSTICK_DRIVER_PRIMITIVE_TYPE Type(void) const { return m_type; }
unsigned int DriverIndex(void) const { return m_driverIndex; }
JOYSTICK_DRIVER_HAT_DIRECTION HatDirection(void) const { return m_hatDirection; }
int Center(void) const { return m_center; }
JOYSTICK_DRIVER_SEMIAXIS_DIRECTION SemiAxisDirection(void) const { return m_semiAxisDirection; }
unsigned int Range(void) const { return m_range; }
const std::string& Keycode(void) const { return m_keycode; }
JOYSTICK_DRIVER_MOUSE_INDEX MouseIndex(void) const { return static_cast<JOYSTICK_DRIVER_MOUSE_INDEX>(m_driverIndex); }
JOYSTICK_DRIVER_RELPOINTER_DIRECTION RelPointerDirection(void) const { return m_relPointerDirection; }
bool operator==(const DriverPrimitive& other) const
{
if (m_type == other.m_type)
{
switch (m_type)
{
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_BUTTON:
{
return m_driverIndex == other.m_driverIndex;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_HAT_DIRECTION:
{
return m_driverIndex == other.m_driverIndex &&
m_hatDirection == other.m_hatDirection;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_SEMIAXIS:
{
return m_driverIndex == other.m_driverIndex &&
m_center == other.m_center &&
m_semiAxisDirection == other.m_semiAxisDirection &&
m_range == other.m_range;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_KEY:
{
return m_keycode == other.m_keycode;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_MOTOR:
{
return m_driverIndex == other.m_driverIndex;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_MOUSE_BUTTON:
{
return m_driverIndex == other.m_driverIndex;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_RELPOINTER_DIRECTION:
{
return m_relPointerDirection == other.m_relPointerDirection;
}
default:
break;
}
}
return false;
}
void ToStruct(JOYSTICK_DRIVER_PRIMITIVE& driver_primitive) const
{
driver_primitive.type = m_type;
switch (m_type)
{
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_BUTTON:
{
driver_primitive.button.index = m_driverIndex;
break;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_HAT_DIRECTION:
{
driver_primitive.hat.index = m_driverIndex;
driver_primitive.hat.direction = m_hatDirection;
break;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_SEMIAXIS:
{
driver_primitive.semiaxis.index = m_driverIndex;
driver_primitive.semiaxis.center = m_center;
driver_primitive.semiaxis.direction = m_semiAxisDirection;
driver_primitive.semiaxis.range = m_range;
break;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_MOTOR:
{
driver_primitive.motor.index = m_driverIndex;
break;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_KEY:
{
const size_t size = sizeof(driver_primitive.key.keycode);
std::strncpy(driver_primitive.key.keycode, m_keycode.c_str(), size - 1);
driver_primitive.key.keycode[size - 1] = '\0';
break;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_MOUSE_BUTTON:
{
driver_primitive.mouse.button = static_cast<JOYSTICK_DRIVER_MOUSE_INDEX>(m_driverIndex);
break;
}
case JOYSTICK_DRIVER_PRIMITIVE_TYPE_RELPOINTER_DIRECTION:
{
driver_primitive.relpointer.direction = m_relPointerDirection;
break;
}
default:
break;
}
}
static void FreeStruct(JOYSTICK_DRIVER_PRIMITIVE& primitive)
{
(void)primitive;
}
private:
JOYSTICK_DRIVER_PRIMITIVE_TYPE m_type = JOYSTICK_DRIVER_PRIMITIVE_TYPE_UNKNOWN;
unsigned int m_driverIndex = 0;
JOYSTICK_DRIVER_HAT_DIRECTION m_hatDirection = JOYSTICK_DRIVER_HAT_UNKNOWN;
int m_center = 0;
JOYSTICK_DRIVER_SEMIAXIS_DIRECTION m_semiAxisDirection = JOYSTICK_DRIVER_SEMIAXIS_UNKNOWN;
unsigned int m_range = 1;
std::string m_keycode;
JOYSTICK_DRIVER_RELPOINTER_DIRECTION m_relPointerDirection = JOYSTICK_DRIVER_RELPOINTER_UNKNOWN;
};
typedef PeripheralVector<DriverPrimitive, JOYSTICK_DRIVER_PRIMITIVE> DriverPrimitives;
/*!
* kodi::addon::JoystickFeature
*
* Class for joystick features. A feature can be:
*
* 1) scalar[1]
* 2) analog stick
* 3) accelerometer
* 4) motor
* 5) relative pointer[2]
* 6) absolute pointer
* 7) wheel
* 8) throttle
* 9) keyboard key
*
* [1] All three driver primitives (buttons, hats and axes) have a state that
* can be represented using a single scalar value. For this reason,
* features that map to a single primitive are called "scalar features".
*
* [2] Relative pointers are similar to analog sticks, but they use
* relative distances instead of positions.
*/
class JoystickFeature
{
public:
JoystickFeature(const std::string& name = "", JOYSTICK_FEATURE_TYPE type = JOYSTICK_FEATURE_TYPE_UNKNOWN) :
m_name(name),
m_type(type),
m_primitives{}
{
}
JoystickFeature(const JoystickFeature& other)
{
*this = other;
}
explicit JoystickFeature(const JOYSTICK_FEATURE& feature) :
m_name(feature.name ? feature.name : ""),
m_type(feature.type)
{
for (unsigned int i = 0; i < JOYSTICK_PRIMITIVE_MAX; i++)
m_primitives[i] = DriverPrimitive(feature.primitives[i]);
}
JoystickFeature& operator=(const JoystickFeature& rhs)
{
if (this != &rhs)
{
m_name = rhs.m_name;
m_type = rhs.m_type;
m_primitives = rhs.m_primitives;
}
return *this;
}
bool operator==(const JoystickFeature& other) const
{
return m_name == other.m_name &&
m_type == other.m_type &&
m_primitives == other.m_primitives;
}
const std::string& Name(void) const { return m_name; }
JOYSTICK_FEATURE_TYPE Type(void) const { return m_type; }
bool IsValid() const { return m_type != JOYSTICK_FEATURE_TYPE_UNKNOWN; }
void SetName(const std::string& name) { m_name = name; }
void SetType(JOYSTICK_FEATURE_TYPE type) { m_type = type; }
void SetInvalid(void) { m_type = JOYSTICK_FEATURE_TYPE_UNKNOWN; }
const DriverPrimitive& Primitive(JOYSTICK_FEATURE_PRIMITIVE which) const { return m_primitives[which]; }
void SetPrimitive(JOYSTICK_FEATURE_PRIMITIVE which, const DriverPrimitive& primitive) { m_primitives[which] = primitive; }
std::array<DriverPrimitive, JOYSTICK_PRIMITIVE_MAX>& Primitives() { return m_primitives; }
const std::array<DriverPrimitive, JOYSTICK_PRIMITIVE_MAX>& Primitives() const { return m_primitives; }
void ToStruct(JOYSTICK_FEATURE& feature) const
{
feature.name = new char[m_name.length() + 1];
feature.type = m_type;
for (unsigned int i = 0; i < JOYSTICK_PRIMITIVE_MAX; i++)
m_primitives[i].ToStruct(feature.primitives[i]);
std::strcpy(feature.name, m_name.c_str());
}
static void FreeStruct(JOYSTICK_FEATURE& feature)
{
PERIPHERAL_SAFE_DELETE_ARRAY(feature.name);
}
private:
std::string m_name;
JOYSTICK_FEATURE_TYPE m_type;
std::array<DriverPrimitive, JOYSTICK_PRIMITIVE_MAX> m_primitives;
};
typedef PeripheralVector<JoystickFeature, JOYSTICK_FEATURE> JoystickFeatures;
} /* namespace addon */
} /* namespace kodi */