/*
  Keyboard.h

  Copyright (c) 2015, Arduino LLC
  Original code (pre-library): Copyright (c) 2011, Peter Barrett

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/

#pragma once
#include "Print.h"
#include "USBHID.h"

#if CONFIG_TINYUSB_HID_ENABLED

#include "Bad_Usb_Lib.h"
#include "esp_event.h"
#include "keys.h"
ESP_EVENT_DECLARE_BASE(ARDUINO_USB_HID_KEYBOARD_EVENTS);

typedef enum {
    ARDUINO_USB_HID_KEYBOARD_ANY_EVENT = ESP_EVENT_ANY_ID,
    ARDUINO_USB_HID_KEYBOARD_LED_EVENT = 0,
    ARDUINO_USB_HID_KEYBOARD_MAX_EVENT,
} arduino_usb_hid_keyboard_event_t;

typedef union {
    struct {
        uint8_t numlock : 1;
        uint8_t capslock : 1;
        uint8_t scrolllock : 1;
        uint8_t compose : 1;
        uint8_t kana : 1;
        uint8_t reserved : 3;
    };
    uint8_t leds;
} arduino_usb_hid_keyboard_event_data_t;

class USBHIDKeyboard : public USBHIDDevice, public HIDInterface {
private:
    USBHID hid;
    KeyReport _keyReport;
    const uint8_t *_asciimap;
    bool shiftKeyReports;
    uint32_t _delay_ms = 10; // Default delay between keystrokes - actual value loaded from config
    uint8_t _keySlotMap[6];
    uint8_t _shiftCache[128];
    bool _cacheValid;

public:
    USBHIDKeyboard();
    void begin(const uint8_t *layout = KeyboardLayout_en_US);
    void end(void);
    size_t write(uint8_t k);
    size_t write(const uint8_t *buffer, size_t size);
    size_t press(uint8_t k);
    size_t release(uint8_t k);
    void releaseAll(void);
    void setLayout(const uint8_t *layout) override {
        _asciimap = layout;
        _cacheValid = false;
        _buildShiftCache();
    };
    void sendReport(KeyReport *keys);
    void setShiftKeyReports(bool set);

    // raw functions work with TinyUSB's HID_KEY_* macros
    size_t pressRaw(uint8_t k);
    size_t releaseRaw(uint8_t k);

    void onEvent(esp_event_handler_t callback);
    void onEvent(arduino_usb_hid_keyboard_event_t event, esp_event_handler_t callback);

    // internal use
    uint16_t _onGetDescriptor(uint8_t *buffer);
    void _onOutput(uint8_t report_id, const uint8_t *buffer, uint16_t len);
    void _buildShiftCache();

    void setDelay(uint32_t ms);
};

#endif /* CONFIG_TINYUSB_HID_ENABLED */