pawkit-c 0.1.7

PawKit's C(++) bindings
Documentation
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
#pragma once

#include "input.h"
#include "util.h"

#include <memory>
#include <span>
#include <optional>
#include <string_view>
#include <utility>
#include <variant>

namespace PawKit::Input {
    enum struct MouseAxis : pawkit_input_mouseaxis_t {
        DeltaX,
        DeltaY,
        WheelX,
        WheelY,
    };

    enum struct JoyAxis : pawkit_input_joyaxis_t {
        LeftX,
        LeftY,
        RightX,
        RightY,
    };

    enum struct KeyButton : pawkit_input_keybutton_t {
        A, B, C, D,
        E, F, G, H,
        I, J, K, L,
        M, N, O, P,
        Q, R, S, T,
        U, V, W, X,
        Y, Z,

        Number0, Number1, Number2,
        Number3, Number4, Number5,
        Number6, Number7, Number8,
        Number9,

        Up, Down, Left, Right,

        Tilde, Grave, Minus, Plus,
        LeftBracket, RightBracket, Semicolon,
        Quote, Comma, Period,
        Slash, Backslash,

        LeftShift, RightShift,
        LeftControl, RightControl,
        LeftAlt, RightAlt,
        LeftMeta, RightMeta,

        Menu, Enter, Escape, Space,
        Tab, Backspace, Insert,
        Delete, PageUp, PageDown,
        Home, End, CapsLock,
        ScrollLock, PrintScreen, Pause,
        NumLock, Clear, Sleep,

        Numpad0, Numpad1, Numpad2,
        Numpad3, Numpad4, Numpad5,
        Numpad6, Numpad7, Numpad8,
        Numpad9, NumpadDivide,
        NumpadMultiply, NumpadMinus,
        NumpadPlus, NumpadDecimal,
        NumpadPeriod, NumpadEnter,

        F1, F2, F3, F4,
        F5, F6, F7, F8,
        F9, F10, F11, F12,
        F13, F14, F15, F16,
        F17, F18, F19, F20,
        F21, F22, F23, F24,
    };

    enum struct MouseButton : pawkit_input_mousebutton_t {
        Left,
        Right,
        Middle,
        Side1,
        Side2
    };

    enum struct JoyButton : pawkit_input_joybutton_t {
        South,
        East,
        West,
        North,
        Back,
        Guide,
        Start,
        LeftStick,
        RightStick,
        LeftShoulder,
        RightShoulder,
        DpadUp,
        DpadDown,
        DpadLeft,
        DpadRight,
        Misc1,
        RightPaddle1,
        LeftPaddle1,
        RightPaddle2,
        LeftPaddle2,
        Touchpad,
        Misc2,
        Misc3,
        Misc4,
        Misc5,
        Misc6,
    };

    enum struct Family : pawkit_input_family_t {
       Key,
       Mouse,
       Joy, 
    };

    template <typename TAxis>
    struct AnalogButton final {
        TAxis axis;
        pawkit_f32 threshold;
    };

    using BoundKeyButton = KeyButton;
    using BoundMouseButton = std::variant<MouseButton, AnalogButton<MouseAxis>>;
    using BoundJoyButton = std::variant<JoyButton, AnalogButton<JoyAxis>>;

    template <typename TButton>
    struct MultiDigitalAxis final {
        TButton positive;
        TButton negative;
    };

    using BoundKeyAxis = std::variant<KeyButton, MultiDigitalAxis<KeyButton>>;
    using BoundMouseAxis = std::variant<MouseAxis, MouseButton, MultiDigitalAxis<MouseButton>>;
    using BoundJoyAxis = std::variant<JoyAxis, JoyButton, MultiDigitalAxis<JoyButton>>;

    template <Family TFamily>
    struct FamilyTraits;

    template <>
    struct FamilyTraits<Family::Key> {
        using Button = KeyButton;
        using Axis = void;
        using BoundButton = BoundKeyButton;
        using BoundAxis = BoundKeyAxis;

        static pawkit_input_bound_button_t GetDigital(BoundButton button) {
            return {
                .type = PAWKIT_INPUT_BOUND_BUTTON_TYPE_DIGITAL,
                .button = pawkit_input_button_t(button),
            };
        }

        static pawkit_input_bound_axis_t GetAnalog(BoundAxis axis) {
            if (auto value = std::get_if<Button>(&axis)) {
                return {
                    .type = PAWKIT_INPUT_BOUND_AXIS_TYPE_DIGITAL,
                    .button = pawkit_input_button_t(*value),
                };
            } else if (auto value = std::get_if<MultiDigitalAxis<Button>>(&axis)) {
                return {
                    .type = PAWKIT_INPUT_BOUND_AXIS_TYPE_MULTI_DIGITAL,
                    .positive = pawkit_input_button_t(value->positive),
                    .negative = pawkit_input_button_t(value->negative),
                };
            }

            std::unreachable();
        }
    };

    template <>
    struct FamilyTraits<Family::Mouse> {
        using Button = MouseButton;
        using Axis = MouseAxis;
        using BoundButton = BoundMouseButton;
        using BoundAxis = BoundMouseAxis;

        static pawkit_input_bound_button_t GetDigital(BoundButton button) {
            if (auto value = std::get_if<Button>(&button)) {
                return {
                    .type = PAWKIT_INPUT_BOUND_BUTTON_TYPE_DIGITAL,
                    .button = pawkit_input_button_t(*value),
                };
            } else if (auto value = std::get_if<AnalogButton<Axis>>(&button)) {
                return {
                    .type = PAWKIT_INPUT_BOUND_BUTTON_TYPE_ANALOG,
                    .axis = pawkit_input_axis_t(value->axis),
                    .threshold = value->threshold,
                };
            }

            std::unreachable();
        }

        static pawkit_input_bound_axis_t GetAnalog(BoundAxis axis) {
            if (auto value = std::get_if<Axis>(&axis)) {
                return {
                    .type = PAWKIT_INPUT_BOUND_AXIS_TYPE_ANALOG,
                    .button = pawkit_input_axis_t(*value),
                };
            } else if (auto value = std::get_if<Button>(&axis)) {
                return {
                    .type = PAWKIT_INPUT_BOUND_AXIS_TYPE_DIGITAL,
                    .button = pawkit_input_button_t(*value),
                };
            } else if (auto value = std::get_if<MultiDigitalAxis<Button>>(&axis)) {
                return {
                    .type = PAWKIT_INPUT_BOUND_AXIS_TYPE_MULTI_DIGITAL,
                    .positive = pawkit_input_button_t(value->positive),
                    .negative = pawkit_input_button_t(value->negative),
                };
            }

            std::unreachable();
        }
    };

    template <>
    struct FamilyTraits<Family::Joy> {
        using Button = JoyButton;
        using Axis = JoyAxis;
        using BoundButton = BoundJoyButton;
        using BoundAxis = BoundJoyAxis;

        static pawkit_input_bound_button_t GetDigital(BoundButton button) {
            if (auto value = std::get_if<Button>(&button)) {
                return {
                    .type = PAWKIT_INPUT_BOUND_BUTTON_TYPE_DIGITAL,
                    .button = pawkit_input_button_t(*value),
                };
            } else if (auto value = std::get_if<AnalogButton<Axis>>(&button)) {
                return {
                    .type = PAWKIT_INPUT_BOUND_BUTTON_TYPE_ANALOG,
                    .axis = pawkit_input_axis_t(value->axis),
                    .threshold = value->threshold,
                };
            }

            std::unreachable();
        }

        static pawkit_input_bound_axis_t GetAnalog(BoundAxis axis) {
            if (auto value = std::get_if<Axis>(&axis)) {
                return {
                    .type = PAWKIT_INPUT_BOUND_AXIS_TYPE_ANALOG,
                    .button = pawkit_input_axis_t(*value),
                };
            } else if (auto value = std::get_if<Button>(&axis)) {
                return {
                    .type = PAWKIT_INPUT_BOUND_AXIS_TYPE_DIGITAL,
                    .button = pawkit_input_button_t(*value),
                };
            } else if (auto value = std::get_if<MultiDigitalAxis<Button>>(&axis)) {
                return {
                    .type = PAWKIT_INPUT_BOUND_AXIS_TYPE_MULTI_DIGITAL,
                    .positive = pawkit_input_button_t(value->positive),
                    .negative = pawkit_input_button_t(value->negative),
                };
            }

            std::unreachable();
        }
    };

    template <Family TFamily>
    using BoundButton = FamilyTraits<TFamily>::BoundButton;

    template <Family TFamily>
    using BoundAxis = FamilyTraits<TFamily>::BoundAxis;

    template <Family TFamily>
    using Button = FamilyTraits<TFamily>::Button;

    template <Family TFamily>
    using Axis = FamilyTraits<TFamily>::Axis;

    template <Family TFamily>
    struct DigitalBinding final {
        BoundButton<TFamily> button;

        operator pawkit_input_digital_binding_t () {
            return {
                .family = pawkit_input_family_t(TFamily),
                .binding = FamilyTraits<TFamily>::GetDigital(button)
            };
        }
    };

    template <Family TFamily>
    struct AnalogBinding final {
        BoundAxis<TFamily> axis;
        pawkit_f32 deadzone;
        pawkit_f32 scale;

        operator pawkit_input_analog_binding_t () {
            return {
                .family = pawkit_input_family_t(TFamily),
                .binding = FamilyTraits<TFamily>::GetAnalog(axis),
                .deadzone = deadzone,
                .scale = scale,
            };
        }
    };

    template <Family TFamily>
    struct VectorBinding final {
        BoundAxis<TFamily> x;
        BoundAxis<TFamily> y;
        pawkit_f32 deadzone;
        pawkit_f32 scaleX;
        pawkit_f32 scaleY;

        operator pawkit_input_vector_binding_t () {
            return {
                .family = pawkit_input_family_t(TFamily),
                .x = FamilyTraits<TFamily>::GetAnalog(x),
                .y = FamilyTraits<TFamily>::GetAnalog(y),
                .deadzone = deadzone,
                .scale_x = scaleX,
                .scale_y = scaleY,
            };
        }
    };

    struct DigitalFrame final {
        bool value;
        bool justPressed;
        bool justReleased;
    };

    struct AnalogFrame final {
        pawkit_f32 value;
        pawkit_f32 delta;
    };

    struct VectorFrame final {
        pawkit_f32 x;
        pawkit_f32 y;
        pawkit_f32 deltaX;
        pawkit_f32 deltaY;
    };

    using Frame = std::variant<DigitalFrame, AnalogFrame, VectorFrame>;

    template <Family TFamily>
    struct State final {
        State() = delete;
        State(State const &copy) = delete;
        State(State &&move) = delete;
        ~State() = delete;
        void operator delete (void *) = delete;

        operator pawkit_input_state_t () {
            return reinterpret_cast<pawkit_input_state_t>(this);
        }

        static State *From(pawkit_input_state_t state) {
            return reinterpret_cast<State *>(state);
        }

        inline void SetButton(Button<TFamily> button, bool value) {
            pawkit_input_state_set_button(*this, pawkit_input_button_t(button), value);
        }

        inline void SetAxis(Axis<TFamily> axis, pawkit_f32 value) requires (TFamily != Family::Key) {
            pawkit_input_state_set_axis(*this, pawkit_input_axis_t(axis), value);
        }
    }; 

    struct Manager final  {
        ~Manager() {
            pawkit_input_manager_free(*this);
        };

        Manager() = delete;
        Manager(Manager const &copy) = delete;
        Manager(Manager &&move) = delete;

        operator pawkit_input_manager_t () {
            return reinterpret_cast<pawkit_input_manager_t>(this);
        }

        void operator delete (void *ptr) {
            // Empty to avoid double free.
        }

        static Manager *From(pawkit_input_manager_t list) {
            return reinterpret_cast<Manager *>(list);
        }

        template <Family TFamily>
        inline bool RegisterDigitalBinding(std::string_view name, std::span<DigitalBinding<TFamily>> bindings) {
            std::unique_ptr<pawkit_input_binding_t[]> rawBindingsPtr {new pawkit_input_binding_t[bindings.size()]};

            for (pawkit_usize i = 0; i < bindings.size(); i++) {
                rawBindingsPtr[i] = {
                    .digital = bindings[i],
                };
            }

            pawkit_input_manager_register_binding(*this, name.data(), name.size(), PAWKIT_INPUT_BINDING_DIGITAL, rawBindingsPtr.get(), bindings.size());
        }

        template <Family TFamily>
        inline bool RegisterAnalogBinding(std::string_view name, std::span<AnalogBinding<TFamily>> bindings) {
            std::unique_ptr<pawkit_input_binding_t[]> rawBindingsPtr {new pawkit_input_binding_t[bindings.size()]};

            for (pawkit_usize i = 0; i < bindings.size(); i++) {
                rawBindingsPtr[i] = {
                    .analog = bindings[i],
                };
            }

            pawkit_input_manager_register_binding(*this, name.data(), name.size(), PAWKIT_INPUT_BINDING_ANALOG, rawBindingsPtr.get(), bindings.size());
        }

        template <Family TFamily>
        inline bool RegisterVectorBinding(std::string_view name, std::span<VectorBinding<TFamily>> bindings) {
            std::unique_ptr<pawkit_input_binding_t[]> rawBindingsPtr {new pawkit_input_binding_t[bindings.size()]};

            for (pawkit_usize i = 0; i < bindings.size(); i++) {
                rawBindingsPtr[i] = {
                    .vector = bindings[i],
                };
            }

            pawkit_input_manager_register_binding(*this, name.data(), name.size(), PAWKIT_INPUT_BINDING_VECTOR, rawBindingsPtr.get(), bindings.size());
        }

        inline void LockBindings() {
            pawkit_input_manager_lock_bindings(*this);
        }

        template <Family TFamily>
        inline void DeviceConnected(pawkit_usize id) {
            pawkit_input_manager_device_connected(*this, pawkit_input_family_t(TFamily), id);
        }

        template <Family TFamily>
        inline void DeviceDisconnected(pawkit_usize id) {
            pawkit_input_manager_device_disconnected(*this, pawkit_input_family_t(TFamily), id);
        }
        
        template <Family TFamily>
        inline State<TFamily> *GetState(pawkit_usize id) {
            return State<TFamily>::From(pawkit_input_manager_get_state(*this, pawkit_input_family_t(TFamily), id));
        }

        inline pawkit_usize CreateHandler() {
            return pawkit_input_manager_create_handler(*this);
        }

        inline void freeHandler(pawkit_usize handler) {
            pawkit_input_manager_free_handler(*this, handler);
        }

        inline void Update() {
            pawkit_input_manager_update(*this);
        }

        inline std::optional<DigitalFrame> GetDigitalFrame(pawkit_usize handler, std::string_view name) {
            pawkit_input_frame_t rawFrame;

            if (!pawkit_input_manager_get_frame(*this, handler, name.data(), name.size(), &rawFrame))
                return std::nullopt;

            if (rawFrame.type != PAWKIT_INPUT_BINDING_DIGITAL)
                return std::nullopt;

            return DigitalFrame {
                .value = rawFrame.digital.value,
                .justPressed = rawFrame.digital.just_pressed,
                .justReleased = rawFrame.digital.just_released,
            };
        }

        inline std::optional<AnalogFrame> GetAnalogFrame(pawkit_usize handler, std::string_view name) {
            pawkit_input_frame_t rawFrame;

            if (!pawkit_input_manager_get_frame(*this, handler, name.data(), name.size(), &rawFrame))
                return std::nullopt;

            if (rawFrame.type != PAWKIT_INPUT_BINDING_ANALOG)
                return std::nullopt;

            return AnalogFrame {
                .value = rawFrame.analog.value,
                .delta = rawFrame.analog.delta,
            };
        }

        inline std::optional<VectorFrame> GetVectorFrame(pawkit_usize handler, std::string_view name) {
            pawkit_input_frame_t rawFrame;

            if (!pawkit_input_manager_get_frame(*this, handler, name.data(), name.size(), &rawFrame))
                return std::nullopt;

            if (rawFrame.type != PAWKIT_INPUT_BINDING_VECTOR)
                return std::nullopt;

            return VectorFrame {
                .x = rawFrame.vector.x,
                .y = rawFrame.vector.y,
                .deltaX = rawFrame.vector.delta_x,
                .deltaY = rawFrame.vector.delta_y,
            };
        }

        inline std::optional<Frame> GetFrame(pawkit_usize handler, std::string_view name) {
            pawkit_input_frame_t rawFrame;

            if (!pawkit_input_manager_get_frame(*this, handler, name.data(), name.size(), &rawFrame))
                return std::nullopt;

            if (rawFrame.type == PAWKIT_INPUT_BINDING_DIGITAL) {
                return DigitalFrame {
                    .value = rawFrame.digital.value,
                    .justPressed = rawFrame.digital.just_pressed,
                    .justReleased = rawFrame.digital.just_released,
                };
            } else if (rawFrame.type == PAWKIT_INPUT_BINDING_ANALOG) {
                return AnalogFrame {
                    .value = rawFrame.analog.value,
                    .delta = rawFrame.analog.delta,
                };
            } else if (rawFrame.type == PAWKIT_INPUT_BINDING_VECTOR) {
                return VectorFrame {
                    .x = rawFrame.vector.x,
                    .y = rawFrame.vector.y,
                    .deltaX = rawFrame.vector.delta_x,
                    .deltaY = rawFrame.vector.delta_y,
                };
            }

            return std::nullopt;
        }

        template <Family TFamily>
        inline void ConnectDeviceToHandler(pawkit_usize handler, pawkit_usize device) {
            pawkit_input_manager_connect_device_to_handler(*this, handler, pawkit_input_family_t(TFamily), device);
        }

        template <Family TFamily>
        inline void DisconnectDeviceFromHandler(pawkit_usize handler, pawkit_usize device) {
            pawkit_input_manager_disconnect_device_from_handler(*this, handler, pawkit_input_family_t(TFamily), device);
        }
    };
}