button_script.h

//---------------------------------------------------------------------------

#pragma once
#include "bit_field.h"
#include "button_state.h"
#include "scan_code_action.h"
#include "script.h"
#include "steno_key_state.h"
#include "writer.h"
#include <stddef.h>
#include <stdint.h>

//---------------------------------------------------------------------------

enum class ButtonScriptId : int {
  DISPLAY_OVERLAY,
  BATTERY_UPDATE,
  CONNECTION_UPDATE,
  PAIR_CONNECTION_UPDATE,
  KEYBOARD_LED_STATUS_UPDATE,
  BLE_ADVERTISING_UPDATE,
  BLE_SCANNING_UPDATE,
  U2F_STATUS_UPDATE,
  U2F_WINK,
  STENO_MODE_UPDATE,
  BLE_PAIR_COMPLETE,

  USER1,
  USER2,
  USER3,
  USER4,
  USER5,
  USER6,
  USER7,
  USER8,

  COUNT,
};

//---------------------------------------------------------------------------

class ButtonScript : public Script {
public:
  ButtonScript(const uint8_t *byteCode);

  void ExecuteInitScript(uint32_t scriptTime) {
    ExecuteScriptIndex(0, scriptTime);
  }
  void ExecuteTickScript(uint32_t scriptTime) {
    ExecuteScriptIndex(1, scriptTime);
  }
  void ExecuteScriptIndex(size_t index, uint32_t scriptTime);
  void ExecuteScriptIndex(size_t index, uint32_t scriptTime,
                          const intptr_t *parameters, size_t parameterCount);

  void ExecuteScriptId(ButtonScriptId scriptId, uint32_t scriptTime);

  // These are done outside of Handle() as handle will be affected by
  // PressAll/CallAllReleaseScripts.
  void IncrementPressCount() { ++pressCount; }
  void IncrementReleaseCount() { ++releaseCount; }

  void HandlePress(size_t keyIndex, uint32_t scriptTime) {
    buttonState.Set(keyIndex);
    CallPress(keyIndex, scriptTime);
  }

  void HandleRelease(size_t keyIndex, uint32_t scriptTime) {
    buttonState.Clear(keyIndex);
    CallRelease(keyIndex, scriptTime);
  }

  void PrintInfo() const;

  bool IsTickScriptEmpty() const { return IsScriptIndexEmpty(1); }

  static bool IsWaitingForUserPresence();
  static void ReplyUserPresence(bool present);

  void EnableScriptEvents() { scriptEventsEnabled = true; }
  void DisableScriptEvents() { scriptEventsEnabled = false; }

  void PrintEventHistory();

  void Reset();

  class TestHelper;

private:
  class Function;
  class TimerContext;

  static const size_t EVENT_HISTORY_COUNT = 4;
  static const size_t MAX_STACK_SIZE = 256;
  static void (*const FUNCTION_TABLE[])(ButtonScript &);

  bool scriptEventsEnabled = false;
  uint8_t inPressAllCount = 0;
  uint8_t inReleaseAllCount = 0;
  uint32_t pressCount = 0;
  uint32_t releaseCount = 0;
  uint32_t scriptTime;
  StenoKeyState stenoState;
  const char *eventHistory[EVENT_HISTORY_COUNT] = {};
  size_t scriptOffsets[(size_t)ButtonScriptId::COUNT];
  ButtonState buttonState;
  BitField<256> keyState;
  BitField<32> mouseButtonState;
  LimitedBufferWriter consoleWriter;

  void ExecuteScript(size_t offset, uint32_t scriptTime);

  bool IsScriptEmpty(size_t offset) const;

  void StartTimer(int32_t timerId, uint32_t interval, bool isRepeating,
                  size_t offset);
  void StopTimer(int32_t timerId);

  friend class ScriptTestHelper;

  void OnStenoKeyPressed();
  void OnStenoKeyReleased();
  void CancelStenoKeys(StenoKeyState state);
  void CancelAllStenoKeys();
  bool ProcessScanCode(int scanCode, ScanCodeAction action);
  void ReleaseAll();

  void SendText(const uint8_t *text);
  void RunConsoleCommand(const char *command);

  void SetScript(ButtonScriptId scriptId, size_t scriptOffset) {
    if (scriptId < ButtonScriptId::COUNT) {
      scriptOffsets[(size_t)scriptId] = scriptOffset;
    }
  }

  void CallPress(size_t keyIndex, uint32_t scriptTime) {
    ExecuteScriptIndex(keyIndex * 2 + 2, scriptTime);
  }
  void CallRelease(size_t keyIndex, uint32_t scriptTime) {
    ExecuteScriptIndex(keyIndex * 2 + 3, scriptTime);
  }
};

//---------------------------------------------------------------------------