tRacket-sensor

/// @file
/// @brief Arduino Library for generating UUID's
/// @author Rob Tillaart
#pragma once
//
//    FILE: UUID.h
//  AUTHOR: Rob Tillaart
// VERSION: 0.1.6
//    DATE: 2022-06-14
// PURPOSE: Arduino Library for generating UUID's
//     URL: https://github.com/RobTillaart/UUID
//          https://en.wikipedia.org/wiki/Universally_unique_identifier
//
// e.g.     20d24650-d900-e34f-de49-8964ab3eb46d


#include "Arduino.h"
#include "Printable.h"

#include <cstddef>
#include <cstdint>

#define UUID_LIB_VERSION              (F("0.1.6"))

//  TODO an enum?
const uint8_t UUID_MODE_VARIANT4 = 0;
const uint8_t UUID_MODE_RANDOM   = 1;


/////////////////////////////////////////////////
//
//  CLASS VERSION
//
class UUID : public Printable
{
public:
  /**
   * Generates a new UUID using the given seeds.
   * @param s1 Seed 1
   * @param s2 Seed 2
   */
  explicit UUID(uint32_t s1 = 1, uint32_t s2 = 2);

  /** Generate a new UUID */
  void     generate();
  /**
   * Make a UUID string
   * @return String representation of UUID
   */
  const char * toCharArray() const;
  /**
   * Implicit conversion to a String object.
   */
  operator String() const {
    return toCharArray();
  }

  //  MODE
  /** Sets UUID generation to Variant4 mode. */
  void     setVariant4Mode();
  /** Sets UUID generation to Random mode. */
  void     setRandomMode();
  /** Get the current generation mode. */
  uint8_t  getMode();

  /** Printable interface */
  size_t   printTo(Print& p) const;


  //  CASE
  //  (experimental code, not tested yet)
  //  lower case is default and according to spec.
  //  upper case is an additional feature.
  //  must it be done at generation or at toCharArray() ?
  //                     fast       or    flex
  //
  //  void     setLowerCase();
  //  void     setUpperCase();


private:
  //  Marsaglia 'constants' + function
  uint32_t _m_w;
  uint32_t _m_z;
  uint32_t _random();

  //  UUID in string format
  char     _buffer[37];
  uint8_t  _mode = UUID_MODE_VARIANT4;

  // bool     _upperCase = false;
};


//  -- END OF FILE --