NetComm.h

Go to the documentation of this file.

// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
 
#pragma once
 
#include <stdint.h>
 
#include <array>
#include <bit>
#include <limits>
#include <span>
#include <string>
#include <string_view>
#include <utility>
 
#include "mrc/NtNetComm.h"
 
namespace mrc {
 
enum class RobotMode : uint8_t {
  Unknown = 0,
  Autonomous = 1,
  Teleoperated = 2,
  Test = 3
};
 
struct OpModeHash {
  uint64_t Hash : 56 = 0;
  uint64_t RobotMode : 2 = 0;
  uint64_t IsEnabled : 1 = 0;
  uint64_t Reserved : 5 = 0;
 
  static constexpr uint64_t RobotModeMask = 0x0300000000000000;
  static constexpr uint64_t EnabledMask = 0x0400000000000000;
  static constexpr uint64_t HashMask = 0x00FFFFFFFFFFFFFF;
  static constexpr int RobotModeShift = 56;
 
  constexpr static OpModeHash MakeTest(uint64_t Hash, bool Enabled = false) {
    OpModeHash FullHash;
    FullHash.Hash = Hash & HashMask;
    FullHash.RobotMode = static_cast<uint8_t>(RobotMode::Test);
    FullHash.IsEnabled = Enabled ? 1 : 0;
    return FullHash;
  }
 
  constexpr static OpModeHash MakeTele(uint64_t Hash, bool Enabled = false) {
    OpModeHash FullHash;
    FullHash.Hash = Hash & HashMask;
    FullHash.RobotMode = static_cast<uint8_t>(RobotMode::Teleoperated);
    FullHash.IsEnabled = Enabled ? 1 : 0;
    return FullHash;
  }
 
  constexpr static OpModeHash MakeAuto(uint64_t Hash, bool Enabled = false) {
    OpModeHash FullHash;
    FullHash.Hash = Hash & HashMask;
    FullHash.RobotMode = static_cast<uint8_t>(RobotMode::Autonomous);
    FullHash.IsEnabled = Enabled ? 1 : 0;
    return FullHash;
  }
 
  constexpr static OpModeHash FromValue(uint64_t Value) {
    OpModeHash RetVal;
    RetVal.Hash = Value & HashMask;
    RetVal.RobotMode = (Value & RobotModeMask) >> RobotModeShift;
    RetVal.IsEnabled = (Value & EnabledMask) != 0;
    return RetVal;
  }
 
  constexpr uint64_t ToValue() const {
    uint64_t RetVal = Hash & HashMask;
    RetVal |= static_cast<uint64_t>(RobotMode) << RobotModeShift;
    RetVal |= IsEnabled ? EnabledMask : 0;
    return RetVal;
  }
};
 
struct ControlFlags {
  uint32_t Enabled : 1 = 0;
  uint32_t RobotMode : 2 = 0;
  uint32_t EStop : 1 = 0;
  uint32_t FmsConnected : 1 = 0;
  uint32_t DsConnected : 1 = 0;
  uint32_t WatchdogActive : 1 = 0;
  uint32_t SupportsOpModes : 1 = 0;
  uint32_t Alliance : 4 = 0;
  uint32_t Reserved : 20 = 0;
 
  constexpr bool operator==(const ControlFlags& Other) const {
    return Enabled == Other.Enabled && RobotMode == Other.RobotMode &&
           EStop == Other.EStop && FmsConnected == Other.FmsConnected &&
           DsConnected == Other.DsConnected &&
           WatchdogActive == Other.WatchdogActive &&
           SupportsOpModes == Other.SupportsOpModes &&
           Alliance == Other.Alliance;
  }
 
  constexpr bool operator!=(const ControlFlags& Other) const {
    return !(*this == Other);
  }
 
  constexpr void Reset() {
    Enabled = 0;
    RobotMode = 0;
    EStop = 0;
    FmsConnected = 0;
    DsConnected = 0;
    WatchdogActive = 0;
    SupportsOpModes = 0;
    Alliance = 0;
    Reserved = 0;
  }
};
 
struct JoystickAxes {
 public:
  std::span<int16_t> Axes() {
    return std::span{AxesStore.data(), GetMaxAvailableCount()};
  }
 
  std::span<const int16_t> Axes() const {
    return std::span{AxesStore.data(), GetMaxAvailableCount()};
  }
 
  void SetAvailable(uint16_t Available) {
    AvailableAxes = Available & ((1 << MRC_MAX_NUM_AXES) - 1);
    Count = static_cast<uint8_t>(16 - std::countl_zero(AvailableAxes));
  }
 
  uint16_t GetAvailable() const { return AvailableAxes; }
 
  void SetMaxAvailableCount(size_t _Count) {
    if (_Count > MRC_MAX_NUM_AXES) {
      _Count = MRC_MAX_NUM_AXES;
    }
    AvailableAxes = (1 << _Count) - 1;
    Count = static_cast<uint8_t>(_Count);
  }
 
  size_t GetMaxAvailableCount() const { return Count; }
 
 private:
  std::array<int16_t, MRC_MAX_NUM_AXES> AxesStore{};
  uint16_t AvailableAxes{0};
  uint8_t Count{0};
};
 
struct JoystickPovs {
 public:
  std::span<uint8_t> Povs() { return std::span{PovsStore.data(), GetCount()}; }
 
  std::span<const uint8_t> Povs() const {
    return std::span{PovsStore.data(), GetCount()};
  }
 
  void SetCount(uint8_t NewCount) {
    Count = (std::min)(NewCount, static_cast<uint8_t>(MRC_MAX_NUM_POVS));
  }
 
  size_t GetCount() const { return Count; }
 
 private:
  std::array<uint8_t, MRC_MAX_NUM_POVS> PovsStore{};
  uint8_t Count{0};
};
 
struct JoystickButtons {
  uint64_t Buttons{0};
 
  void SetAvailable(uint64_t Available) {
    AvailableButtons = Available;
    Count = static_cast<uint8_t>(64 - std::countl_zero(Available));
  }
 
  uint64_t GetAvailable() const { return AvailableButtons; }
 
  void SetMaxAvailableCount(size_t _Count) {
    if (_Count > 63) {
      AvailableButtons = (std::numeric_limits<uint64_t>::max)();
      Count = MRC_MAX_NUM_BUTTONS;
      return;
    }
    AvailableButtons = (1ULL << _Count) - 1;
    Count = static_cast<uint8_t>(_Count);
  }
 
  size_t GetMaxAvailableCount() const { return Count; }
 
 private:
  uint64_t AvailableButtons{0};
  uint8_t Count{0};
};
 
struct TouchpadFinger {
  bool Down{false};
  uint16_t X{0};
  uint16_t Y{0};
};
 
struct Touchpad {
  std::span<TouchpadFinger> Fingers() {
    return std::span{FingersStore.data(), GetFingerCount()};
  }
 
  std::span<const TouchpadFinger> Fingers() const {
    return std::span{FingersStore.data(), GetFingerCount()};
  }
 
  size_t GetFingerCount() const { return FingerCount; }
 
  void SetFingerCount(uint8_t NewCount) {
    FingerCount =
        (std::min)(NewCount,
                   static_cast<uint8_t>(MRC_MAX_NUM_TOUCHPAD_FINGERS));
  }
 
 private:
  std::array<TouchpadFinger, MRC_MAX_NUM_TOUCHPAD_FINGERS> FingersStore{};
  uint8_t FingerCount{0};
};
 
struct JoystickTouchpads {
  std::span<Touchpad> Touchpads() {
    return std::span{TouchpadsStore.data(), GetTouchpadCount()};
  }
 
  std::span<const Touchpad> Touchpads() const {
    return std::span{TouchpadsStore.data(), GetTouchpadCount()};
  }
 
  size_t GetTouchpadCount() const { return TouchpadCount; }
 
  void SetTouchpadCount(uint8_t NewCount) {
    TouchpadCount =
        (std::min)(NewCount, static_cast<uint8_t>(MRC_MAX_NUM_TOUCHPADS));
  }
 
 private:
  std::array<Touchpad, MRC_MAX_NUM_TOUCHPADS> TouchpadsStore{};
  uint8_t TouchpadCount{0};
};
 
struct Joystick {
  JoystickAxes Axes;
  JoystickPovs Povs;
  JoystickButtons Buttons;
  JoystickTouchpads Touchpads;
};
 
struct ControlData {
  ControlFlags ControlWord;
  uint16_t MatchTime{0};
  OpModeHash CurrentOpMode;
 
  void SetGameData(std::string_view Data) {
    if (Data.size() > MRC_MAX_GAME_DATA_LEN) {
      Data = Data.substr(0, MRC_MAX_GAME_DATA_LEN);
    }
    GameData = Data;
  }
 
  void MoveGameData(std::string&& Data) {
    GameData = std::move(Data);
    if (GameData.size() > MRC_MAX_GAME_DATA_LEN) {
      GameData.resize(MRC_MAX_GAME_DATA_LEN);
    }
  }
 
  std::string_view GetGameData() const { return GameData; }
 
  std::span<Joystick> Joysticks() {
    return std::span{JoysticksStore.data(), GetJoystickCount()};
  }
 
  std::span<const Joystick> Joysticks() const {
    return std::span{JoysticksStore.data(), GetJoystickCount()};
  }
 
  size_t GetJoystickCount() const { return JoystickCount; }
 
  void SetJoystickCount(uint8_t NewCount) {
    JoystickCount =
        (std::min)(NewCount, static_cast<uint8_t>(MRC_MAX_NUM_JOYSTICKS));
  }
 
 private:
  std::string GameData;
  std::array<Joystick, MRC_MAX_NUM_JOYSTICKS> JoysticksStore;
  uint8_t JoystickCount{0};
};
 
struct JoystickOutput {
 public:
  uint8_t R{0};
  uint8_t G{0};
  uint8_t B{0};
  uint16_t LeftRumble{0};
  uint16_t RightRumble{0};
  uint16_t LeftTriggerRumble{0};
  uint16_t RightTriggerRumble{0};
 
  bool IsEmpty() const {
    return R == 0 && G == 0 && B == 0 && LeftRumble == 0 && RightRumble == 0 &&
           LeftTriggerRumble == 0 && RightTriggerRumble == 0;
  }
};
 
struct JoystickOutputs {
  std::span<JoystickOutput> Outputs() {
    return std::span{OutputsStore.data(), GetOutputCount()};
  }
 
  std::span<const JoystickOutput> Outputs() const {
    return std::span{OutputsStore.data(), GetOutputCount()};
  }
 
  size_t GetOutputCount() const { return OutputCount; }
 
  void SetOutputCount(uint8_t NewCount) {
    OutputCount =
        (std::min)(NewCount, static_cast<uint8_t>(MRC_MAX_NUM_JOYSTICKS));
  }
 
 private:
  std::array<JoystickOutput, MRC_MAX_NUM_JOYSTICKS> OutputsStore;
  uint8_t OutputCount{0};
};
 
enum class MatchType : uint8_t {
  None = 0,
  Practice = 1,
  Qualification = 2,
  Playoff = 3,
  Test = 4,
};
 
struct MatchInfo {
  uint16_t MatchNumber{0};
  uint8_t ReplayNumber{0};
  MatchType Type{MatchType::None};
 
  void SetEventName(std::string_view Name) {
    if (Name.size() > MRC_MAX_EVENT_NAME_LEN) {
      Name = Name.substr(0, MRC_MAX_EVENT_NAME_LEN);
    }
    EventName = Name;
  }
 
  void MoveEventName(std::string&& Name) {
    EventName = std::move(Name);
    if (EventName.size() > MRC_MAX_EVENT_NAME_LEN) {
      EventName.resize(MRC_MAX_EVENT_NAME_LEN);
    }
  }
 
  std::string_view GetEventName() const { return EventName; }
 
  std::span<uint8_t> WritableNameBuffer(size_t Len) {
    if (Len > MRC_MAX_EVENT_NAME_LEN) {
      Len = MRC_MAX_EVENT_NAME_LEN;
    }
    EventName.resize(Len);
    return std::span<uint8_t>{reinterpret_cast<uint8_t*>(EventName.data()),
                              EventName.size()};
  }
 
  bool operator==(const MatchInfo& Other) const {
    return MatchNumber == Other.MatchNumber &&
           ReplayNumber == Other.ReplayNumber && Type == Other.Type &&
           EventName == Other.EventName;
  }
 
 private:
  std::string EventName;
};
 
struct JoystickDescriptor {
 public:
  bool IsGamepad{false};
  uint8_t GamepadType{0};
  uint8_t SupportedOutputs{0};
 
  void SetName(std::string_view Name) {
    if (Name.size() > MRC_MAX_JOYSTICK_NAME_LEN) {
      Name = Name.substr(0, MRC_MAX_JOYSTICK_NAME_LEN);
    }
    JoystickName = Name;
  }
 
  void MoveName(std::string&& Name) {
    JoystickName = std::move(Name);
    if (JoystickName.size() > MRC_MAX_JOYSTICK_NAME_LEN) {
      JoystickName.resize(MRC_MAX_JOYSTICK_NAME_LEN);
    }
  }
 
  std::string_view GetName() const { return JoystickName; }
 
  std::span<uint8_t> WritableNameBuffer(size_t Len) {
    if (Len > MRC_MAX_JOYSTICK_NAME_LEN) {
      Len = MRC_MAX_JOYSTICK_NAME_LEN;
    }
    JoystickName.resize(Len);
    return std::span<uint8_t>{reinterpret_cast<uint8_t*>(JoystickName.data()),
                              JoystickName.size()};
  }
 
 private:
  std::string JoystickName;
};
 
struct JoystickDescriptors {
  std::span<JoystickDescriptor> Descriptors() {
    return std::span{DescriptorsStore.data(), GetDescriptorCount()};
  }
 
  std::span<const JoystickDescriptor> Descriptors() const {
    return std::span{DescriptorsStore.data(), GetDescriptorCount()};
  }
 
  size_t GetDescriptorCount() const { return DescriptorCount; }
 
  void SetDescriptorCount(uint8_t NewCount) {
    DescriptorCount =
        (std::min)(NewCount, static_cast<uint8_t>(MRC_MAX_NUM_JOYSTICKS));
  }
 
 private:
  std::array<JoystickDescriptor, MRC_MAX_NUM_JOYSTICKS> DescriptorsStore;
  uint8_t DescriptorCount{0};
};
 
struct ErrorInfo {
  bool IsError{false};
  int32_t ErrorCode{0};
 
  void SetDetails(std::string_view NewDetails) {
    if (NewDetails.size() > MRC_MAX_ERROR_INFO_STR_LEN) {
      NewDetails = NewDetails.substr(0, MRC_MAX_ERROR_INFO_STR_LEN);
    }
    Details = NewDetails;
  }
 
  void MoveDetails(std::string&& NewDetails) {
    Details = std::move(NewDetails);
    if (Details.size() > MRC_MAX_ERROR_INFO_STR_LEN) {
      Details.resize(MRC_MAX_ERROR_INFO_STR_LEN);
    }
  }
 
  std::string_view GetDetails() const { return Details; }
 
  std::span<uint8_t> WritableDetailsBuffer(size_t Len) {
    if (Len > MRC_MAX_ERROR_INFO_STR_LEN) {
      Len = MRC_MAX_ERROR_INFO_STR_LEN;
    }
    Details.resize(Len);
    return std::span<uint8_t>{reinterpret_cast<uint8_t*>(Details.data()),
                              Details.size()};
  }
 
  void SetLocation(std::string_view NewLocation) {
    if (NewLocation.size() > MRC_MAX_ERROR_INFO_STR_LEN) {
      NewLocation = NewLocation.substr(0, MRC_MAX_ERROR_INFO_STR_LEN);
    }
    Location = NewLocation;
  }
 
  void MoveLocation(std::string&& NewLocation) {
    Location = std::move(NewLocation);
    if (Location.size() > MRC_MAX_ERROR_INFO_STR_LEN) {
      Location.resize(MRC_MAX_ERROR_INFO_STR_LEN);
    }
  }
 
  std::string_view GetLocation() const { return Location; }
 
  std::span<uint8_t> WritableLocationBuffer(size_t Len) {
    if (Len > MRC_MAX_ERROR_INFO_STR_LEN) {
      Len = MRC_MAX_ERROR_INFO_STR_LEN;
    }
    Location.resize(Len);
    return std::span<uint8_t>{reinterpret_cast<uint8_t*>(Location.data()),
                              Location.size()};
  }
 
  void SetCallStack(std::string_view NewCallStack) {
    if (NewCallStack.size() > MRC_MAX_ERROR_INFO_STR_LEN) {
      NewCallStack = NewCallStack.substr(0, MRC_MAX_ERROR_INFO_STR_LEN);
    }
    CallStack = NewCallStack;
  }
 
  void MoveCallStack(std::string&& NewCallStack) {
    CallStack = std::move(NewCallStack);
    if (CallStack.size() > MRC_MAX_ERROR_INFO_STR_LEN) {
      CallStack.resize(MRC_MAX_ERROR_INFO_STR_LEN);
    }
  }
 
  std::string_view GetCallStack() const { return CallStack; }
 
  std::span<uint8_t> WritableCallStackBuffer(size_t Len) {
    if (Len > MRC_MAX_ERROR_INFO_STR_LEN) {
      Len = MRC_MAX_ERROR_INFO_STR_LEN;
    }
    CallStack.resize(Len);
    return std::span<uint8_t>{reinterpret_cast<uint8_t*>(CallStack.data()),
                              CallStack.size()};
  }
 
 private:
  std::string Details;
  std::string Location;
  std::string CallStack;
};
 
struct OpMode {
  OpMode(OpModeHash _Hash, std::string_view _Name, std::string_view _Group,
         std::string_view _Description, int32_t _TextColor = -1,
         int32_t _BackgroundColor = -1)
      : Hash(_Hash), TextColor{_TextColor}, BackgroundColor{_BackgroundColor} {
    SetName(_Name);
    SetGroup(_Group);
    SetDescription(_Description);
  }
 
  OpMode() = default;
 
  OpModeHash Hash;
 
  void SetName(std::string_view NewName) {
    if (NewName.size() > MRC_MAX_OPMODE_STRING_LEN) {
      NewName = NewName.substr(0, MRC_MAX_OPMODE_STRING_LEN);
    }
    Name = NewName;
  }
 
  void MoveName(std::string&& NewName) {
    Name = std::move(NewName);
    if (Name.size() > MRC_MAX_OPMODE_STRING_LEN) {
      Name.resize(MRC_MAX_OPMODE_STRING_LEN);
    }
  }
 
  std::string_view GetName() const { return Name; }
 
  std::span<uint8_t> WritableNameBuffer(size_t Len) {
    if (Len > MRC_MAX_OPMODE_STRING_LEN) {
      Len = MRC_MAX_OPMODE_STRING_LEN;
    }
    Name.resize(Len);
    return std::span<uint8_t>{reinterpret_cast<uint8_t*>(Name.data()),
                              Name.size()};
  }
 
  void SetGroup(std::string_view NewGroup) {
    if (NewGroup.size() > MRC_MAX_OPMODE_STRING_LEN) {
      NewGroup = NewGroup.substr(0, MRC_MAX_OPMODE_STRING_LEN);
    }
    Group = NewGroup;
  }
 
  void MoveGroup(std::string&& NewGroup) {
    Group = std::move(NewGroup);
    if (Group.size() > MRC_MAX_OPMODE_STRING_LEN) {
      Group.resize(MRC_MAX_OPMODE_STRING_LEN);
    }
  }
 
  std::string_view GetGroup() const { return Group; }
 
  std::span<uint8_t> WritableGroupBuffer(size_t Len) {
    if (Len > MRC_MAX_OPMODE_STRING_LEN) {
      Len = MRC_MAX_OPMODE_STRING_LEN;
    }
    Group.resize(Len);
    return std::span<uint8_t>{reinterpret_cast<uint8_t*>(Group.data()),
                              Group.size()};
  }
 
  void SetDescription(std::string_view NewDescription) {
    if (NewDescription.size() > MRC_MAX_OPMODE_STRING_LEN) {
      NewDescription = NewDescription.substr(0, MRC_MAX_OPMODE_STRING_LEN);
    }
    Description = NewDescription;
  }
 
  void MoveDescription(std::string&& NewDescription) {
    Description = std::move(NewDescription);
    if (Description.size() > MRC_MAX_OPMODE_STRING_LEN) {
      Description.resize(MRC_MAX_OPMODE_STRING_LEN);
    }
  }
 
  std::string_view GetDescription() const { return Description; }
 
  std::span<uint8_t> WritableDescriptionBuffer(size_t Len) {
    if (Len > MRC_MAX_OPMODE_STRING_LEN) {
      Len = MRC_MAX_OPMODE_STRING_LEN;
    }
    Description.resize(Len);
    return std::span<uint8_t>{reinterpret_cast<uint8_t*>(Description.data()),
                              Description.size()};
  }
 
  void SetTextColor(int32_t NewTextColor) { TextColor = NewTextColor; }
 
  int32_t GetTextColor() const { return TextColor; }
 
  void SetBackgroundColor(int32_t NewBackgroundColor) {
    BackgroundColor = NewBackgroundColor;
  }
 
  int32_t GetBackgroundColor() const { return BackgroundColor; }
 
 private:
  std::string Name;
  std::string Group;
  std::string Description;
  int32_t TextColor{-1};
  int32_t BackgroundColor{-1};
};
 
}  // namespace mrc