Guid Class Reference

This class provides a encapsulation of a GUID/UUID/CLSID/IID data structure (128 bit number). More...

#include <Guid.h>

Collaboration diagram for Guid:

Classes
struct	FallBack
class	string
	A class designed to facilitate exchange of Guid::string objects without additional allocations. More...

Public Types
enum	GuidGenMethod { GuidGenDefault , GuidGenRandom , GuidGenByTime }

Public Member Functions
constexpr	Guid ()
	Standard constructor.
	Guid (bool assign)
	Standard constructor (With possible initialization)
	Guid (const std::string &s, FallBack)
constexpr	Guid (std::string_view s)
	Constructor for Guid from string_view.
constexpr	Guid (const char *s)
	Guid (const Guid &c)=default
	Copy constructor.
Guid &	operator= (const Guid &c)=default
auto	operator<=> (const Guid &) const =default
	Magic spaceship operator.
bool	operator== (const Guid &) const =default
bool	operator== (std::string_view str) const
constexpr void	toString (std::span< char, StrLen > buf, bool uppercase=true) const noexcept
	Automatic conversion to string representation.
constexpr std::string	toString (bool uppercase=true) const
constexpr Guid::string	to_fixed_string (bool uppercase=true) const
constexpr void	fromString (std::string_view s)
	Automatic conversion from string representation.
void	fromStringFallBack (const std::string &)
unsigned int	data1 () const
	Allow accessors to member data.
unsigned short	data2 () const
unsigned short	data3 () const
unsigned char	data4 (unsigned int i) const
void	setData1 (unsigned int data)
	Allow modifiers for member data.
void	setData2 (unsigned short data)
void	setData3 (unsigned short data)
void	setData4 (unsigned char data, unsigned int i)

Static Public Member Functions
static constexpr int	stringSize ()
static bool	isGuid (std::string_view) noexcept
static const Guid &	null () noexcept
	NULL-Guid: static class method.
static GuidGenMethod	initGuidGenMethod ()
	Checks for POOL_GUID_TIME or POOL_GUID_RANDOM env variables.
static void	create (Guid &guid, GuidGenMethod method=GuidGenDefault)
	Create a new Guid default method is currently Random, can be changed by param, API or environment.

Static Public Attributes
static constexpr size_t	StrLen = 36
static const GuidGenMethod	m_guidGenMethod = Guid::initGuidGenMethod()

Private Member Functions
constexpr void	setToNull () noexcept

Private Attributes
unsigned int	m_data1 {}
unsigned short	m_data2 {}
unsigned short	m_data3 {}
std::array< unsigned char, 8 >	m_data4 {}

Friends
bool	operator== (std::string_view str, const Guid &rhs)
	Equality operator.
bool	operator!= (std::string_view str, const Guid &rhs)
	Non-equality operator.
std::ostream &	operator<< (std::ostream &os, const Guid &rhs)
	Extraction operators.

Detailed Description

This class provides a encapsulation of a GUID/UUID/CLSID/IID data structure (128 bit number).

Definition at line 25 of file Guid.h.

Member Enumeration Documentation

GuidGenMethod

enum Guid::GuidGenMethod

Enumerator
GuidGenDefault
GuidGenRandom
GuidGenByTime

Definition at line 84 of file Guid.h.

{ GuidGenDefault, GuidGenRandom, GuidGenByTime };

Constructor & Destructor Documentation

Guid() [1/6]

Guid::Guid ( )

inlineconstexpr

Standard constructor.

Definition at line 43 of file Guid.h.

: m_data1(0U), m_data2(0U), m_data3(0U), m_data4() {}

Guid() [2/6]

Guid::Guid ( bool assign )

inlineexplicit

Standard constructor (With possible initialization)

Definition at line 45 of file Guid.h.

: Guid() { if (assign) create(*this); }

Guid() [3/6]

Guid::Guid ( const std::string & s, FallBack  )

inline

Definition at line 48 of file Guid.h.

{ fromStringFallBack(s); }

Guid() [4/6]

Guid::Guid ( std::string_view s )

inlineconstexpr

Constructor for Guid from string_view.

Definition at line 50 of file Guid.h.

{ fromString(s); }

Guid() [5/6]

Guid::Guid ( const char * s )

inlineconstexpr

Definition at line 52 of file Guid.h.

{ fromString(s); }

Guid() [6/6]

Guid::Guid ( const Guid & c )

default

Copy constructor.

Member Function Documentation

create()

void Guid::create ( Guid & guid, GuidGenMethod method = GuidGenDefault )

static

Create a new Guid default method is currently Random, can be changed by param, API or environment.

Create a new Guid.

Definition at line 29 of file Guid.cxx.

                                                  {
   uuid_t me_;
   if (method == GuidGenDefault) method = m_guidGenMethod;
   switch(method) {
    case GuidGenRandom:
      ::uuid_generate(me_);
      break;
    case GuidGenByTime:
      ::uuid_generate_time(me_);
      break;
    default:
      ::uuid_generate(me_);
      break;
   }
   unsigned int *d1 = (unsigned int*)me_;
   unsigned short *d2 = (unsigned short*)(me_ + 4);
   unsigned short *d3 = (unsigned short*)(me_ + 6);
   guid.m_data1 = *d1;
   guid.m_data2 = *d2;
   guid.m_data3 = *d3;
   for (unsigned int i = 0; i < 8; i++) {
      guid.m_data4[i] = me_[i + 8];
   }
}

data1()

unsigned int Guid::data1 ( ) const

inline

Allow accessors to member data.

Definition at line 94 of file Guid.h.

{ return m_data1; }

data2()

unsigned short Guid::data2 ( ) const

inline

Definition at line 95 of file Guid.h.

{ return m_data2; }

data3()

unsigned short Guid::data3 ( ) const

inline

Definition at line 96 of file Guid.h.

{ return m_data3; }

data4()

unsigned char Guid::data4 ( unsigned int i ) const

inline

Definition at line 97 of file Guid.h.

{ if (i < 8) return m_data4[i]; return 0; }

fromString()

void Guid::fromString ( std::string_view s )

constexpr

Automatic conversion from string representation.

Definition at line 143 of file Guid.h.

                                                 {
   // Trim any whitespace
   if(std::is_constant_evaluated() && std::min(sv.find_first_not_of(' '), sv.size()) > 0){
        throw std::runtime_error("Remove spaces from GUID");
   }
   sv.remove_prefix(std::min(sv.find_first_not_of(' '), sv.size()));
   auto last_non_space = sv.find_last_not_of(' ');
   if (last_non_space == std::string_view::npos) {
      sv = {}; // String is empty or all spaces
   } else {
      if(std::is_constant_evaluated() && (sv.size() - last_non_space - 1)!=0){
         throw std::runtime_error("Remove spaces from GUID");
      }
      sv.remove_suffix(sv.size() - last_non_space - 1);
   }
 
   // Validate format
   if (sv.size() != 36 ||
       sv[8] != '-' || sv[13] != '-' || sv[18] != '-' || sv[23] != '-') {
      setToNull();
      if(std::is_constant_evaluated()){
         throw std::runtime_error("failed to compile time parse GUID");
      }
      return;
   }
   bool success = true;
   // Custom constexpr hex parser
   auto parse_hex = [&success](std::string_view part) -> unsigned long long {
      unsigned long long val = 0;
      for (char c : part) {
         val <<= 4; // Multiply by 16
         if (c >= '0' && c <= '9') {
            val += static_cast<unsigned long long>(c - '0');
         } else if (c >= 'a' && c <= 'f') {
            val += static_cast<unsigned long long>(10 + c - 'a');
         } else if (c >= 'A' && c <= 'F') {
            val += static_cast<unsigned long long>(10 + c - 'A');
         } else {
            success = false;
            return 0;
         }
      }
      return val;
   };
 
   // Parse m_data1 (positions 0-7)
   m_data1 = static_cast<unsigned int>(parse_hex(sv.substr(0, 8)));
 
   // Parse m_data2 (positions 9-12)
   m_data2 = static_cast<unsigned short>(parse_hex(sv.substr(9, 4)));
 
   // Parse m_data3 (positions 14-17)
   m_data3 = static_cast<unsigned short>(parse_hex(sv.substr(14, 4)));
 
 
   // Parse m_data4 bytes
   int pos = 19;
   for(int i =0; i< 2; i++){
       auto val = parse_hex(sv.substr(pos, 2));
       m_data4[i] = static_cast<unsigned char>(val);
       pos+=2;
   }
   //Skip the dash at pos 23
   pos = 24;
   for(int i =2; i< 8; i++){
       auto val = parse_hex(sv.substr(pos, 2));
       m_data4[i] = static_cast<unsigned char>(val);
       pos+=2;
   }
 
   if (!success) {
      setToNull();
      if(std::is_constant_evaluated()){
         throw std::runtime_error("failed to compile time parse GUID");
      }
   }
   return;
}

fromStringFallBack()

void Guid::fromStringFallBack

(

const std::string &

s

)

Definition at line 86 of file Guid.cxx.

                                               {
   //If it conforms to correct Guid use fast method
   if(isGuid(s)){
      fromString(s);
      return;
   }
   //If not try "old" more error tolerant method
   //sscanf will correct subtle corner cases: 
   //when the input string was missing a single hexadecimal digit,
   // e.g., 83B9F174-5E27-11E4-98C2-02163E00A82,
   // sscanf still reported 11 successful conversions.
   //So, the outcome is an "auto-corrected" CLID as 83B9F174-5E27-11E4-98C2-02163E00A802
   static const char* const fmt_Guid = "%08X-%04hX-%04hX-%02hhX%02hhX-%02hhX%02hhX%02hhX%02hhX%02hhX%02hhX";
   if (::sscanf(s.c_str(), fmt_Guid, &m_data1, &m_data2, &m_data3,
        &m_data4[0], &m_data4[1], &m_data4[2], &m_data4[3], &m_data4[4], &m_data4[5], &m_data4[6], &m_data4[7]) != 11) {
       setToNull();
   }
   return;
}

initGuidGenMethod()

Guid::GuidGenMethod Guid::initGuidGenMethod ( )

static

Checks for POOL_GUID_TIME or POOL_GUID_RANDOM env variables.

Definition at line 20 of file Guid.cxx.

                                          {
   char* envv = getenv("POOL_GUID_TIME");
   if (envv != 0 && *envv) return GuidGenByTime;
   envv = getenv("POOL_GUID_RANDOM");
   if (envv != 0 && *envv) return GuidGenRandom;
   return GuidGenDefault;
}

isGuid()

bool Guid::isGuid ( std::string_view sv )

staticnoexcept

Definition at line 54 of file Guid.cxx.

                                           {
    // The GUID must be exactly 36 characters long
    if (sv.size() != 36) {
        return false;
    }
 
    // Check for hyphens at specific positions (0-based indices: 8, 13, 18, 23)
    if (sv[8] != '-' || sv[13] != '-' || sv[18] != '-' || sv[23] != '-') {
        return false;
    }
 
    // Validate that all other characters are hexadecimal digits (0-9, a-f, A-F)
    for (size_t i = 0; i < 36; ++i) {
        // Skip hyphen positions
        if (i == 8 || i == 13 || i == 18 || i == 23) {
            continue;
        }
 
        char c = sv[i];
        // Check if it's a valid hex digit
        if (!((c >= '0' && c <= '9') || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'))) {
            return false;
        }
    }
    return true;
}

null()

const Guid & Guid::null ( )

staticnoexcept

NULL-Guid: static class method.

Definition at line 14 of file Guid.cxx.

                                {
   return clid_null;
}

operator<=>()

auto Guid::operator<=> ( const Guid & ) const

default

Magic spaceship operator.

operator=()

Guid & Guid::operator= ( const Guid & c )

default

operator==() [1/2]

bool Guid::operator== ( const Guid & ) const

default

operator==() [2/2]

bool Guid::operator==

(

std::string_view

str

)

const

Definition at line 81 of file Guid.cxx.

                                              {
   return str.size() == Guid::string::stringSize() && *this == Guid(str);
}

setData1()

void Guid::setData1 ( unsigned int data )

inline

Allow modifiers for member data.

Definition at line 100 of file Guid.h.

{ m_data1 = data; }

setData2()

void Guid::setData2 ( unsigned short data )

inline

Definition at line 101 of file Guid.h.

{ m_data2 = data; }

setData3()

void Guid::setData3 ( unsigned short data )

inline

Definition at line 102 of file Guid.h.

{ m_data3 = data; }

setData4()

void Guid::setData4 ( unsigned char data, unsigned int i )

inline

Definition at line 103 of file Guid.h.

{ if (i < 8) m_data4[i] = data; }

setToNull()

void Guid::setToNull ( )

constexprprivatenoexcept

Definition at line 135 of file Guid.h.

                                        {
   m_data1 = 0U;
   m_data2 = 0U;
   m_data3 = 0U;
   m_data4.fill('\0');
}

stringSize()

constexpr int Guid::stringSize ( )

inlinestaticconstexpr

Definition at line 61 of file Guid.h.

{ return StrLen; }

to_fixed_string()

Guid::string Guid::to_fixed_string ( bool uppercase = true ) const

inlineconstexpr

Definition at line 70 of file Guid.h.

                                                                    {
      Guid::string buffer;
      toString(buffer, uppercase);
      return buffer;
   }

toString() [1/2]

std::string Guid::toString ( bool uppercase = true ) const

inlineconstexpr

Definition at line 65 of file Guid.h.

                                                            {
      std::string buf(Guid::string::stringSize(), ' ');
      toString(std::span<char, stringSize()>(buf.data(), stringSize()), uppercase);
      return buf;
   }

toString() [2/2]

void Guid::toString ( std::span< char, StrLen > buf, bool uppercase = true ) const

constexprnoexcept

Automatic conversion to string representation.

Friends And Related Symbol Documentation

operator!=

bool operator!= ( std::string_view str, const Guid & rhs )

friend

Non-equality operator.

Definition at line 108 of file Guid.h.

{ return !(rhs.operator==(str)); }

operator<<

std::ostream & operator<< ( std::ostream & os, const Guid & rhs )

friend

Extraction operators.

Definition at line 106 of file Guid.cxx.

                                                        {
  auto buff = rhs.to_fixed_string();
  os.write(buff.data(), buff.size());
  return os; 
}

operator==

bool operator== ( std::string_view str, const Guid & rhs )

friend

Equality operator.

Definition at line 106 of file Guid.h.

{ return (rhs.operator==(str)); }

Member Data Documentation

m_data1

unsigned int Guid::m_data1 {}

private

Definition at line 114 of file Guid.h.

{};

m_data2

unsigned short Guid::m_data2 {}

private

Definition at line 115 of file Guid.h.

{};

m_data3

unsigned short Guid::m_data3 {}

private

Definition at line 116 of file Guid.h.

{};

m_data4

std::array<unsigned char,8> Guid::m_data4 {}

private

Definition at line 117 of file Guid.h.

{};

m_guidGenMethod

const Guid::GuidGenMethod Guid::m_guidGenMethod = Guid::initGuidGenMethod()

static

Definition at line 85 of file Guid.h.

StrLen

size_t Guid::StrLen = 36

staticconstexpr

Definition at line 27 of file Guid.h.

---

The documentation for this class was generated from the following files:

• Guid.h
• Guid.cxx