audacity::Uuid Class Reference

Utility class that generates and parses UUIDs. More...

#include <Uuid.h>

Collaboration diagram for audacity::Uuid:

Public Types
using	Bytes = std::array< uint8_t, 16 >

Public Member Functions
	Uuid ()
	Creates a nil UUID. More...
	Uuid (const Bytes &data) noexcept
	Creates UUID from the 16 bytes long array. More...
bool	IsNil () const noexcept
	Checks, if the UUID is nil. More...
	operator bool () const noexcept
	Synonymous to !isNil() More...
bool	operator== (const Uuid &other) const noexcept
bool	operator!= (const Uuid &other) const noexcept
bool	operator> (const Uuid &other) const noexcept
bool	operator>= (const Uuid &other) const noexcept
bool	operator< (const Uuid &other) const noexcept
bool	operator<= (const Uuid &other) const noexcept
const Bytes &	ToBytes () const noexcept
	Get the 16 bytes long array with the raw UUID data. More...
std::string	ToString () const
	Get a string in the xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx format. More...
std::string	ToHexString () const
	Get a string in the xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx format. More...
std::size_t	GetHash () const noexcept

Static Public Member Functions
static Uuid	Generate ()
	Generate a new UUID. More...
static Uuid	FromString (const std::string &str)

Private Attributes
Bytes	mData

Detailed Description

Utility class that generates and parses UUIDs.

UUIDs are generated using: UuidCreate on Windows, CFUUIDCreate on macOS, libuuid on other systems.

Definition at line 27 of file Uuid.h.

Member Typedef Documentation

Bytes

using audacity::Uuid::Bytes = std::array<uint8_t, 16>

Definition at line 30 of file Uuid.h.

Constructor & Destructor Documentation

Uuid() [1/2]

Uuid::Uuid

(

)

Creates a nil UUID.

Definition at line 72 of file Uuid.cpp.

    : Uuid(Bytes {})
{
}

Uuid() [2/2]

Uuid::Uuid ( const Bytes &  data )

explicitnoexcept

Creates UUID from the 16 bytes long array.

Definition at line 77 of file Uuid.cpp.

    : mData(data)
{
}

Member Function Documentation

FromString()

Uuid Uuid::FromString ( const std::string &  str )

static

Parses an UUID from the string. This method expects the string to be in xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx or {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx} formats. This will return nil UUID if parsing fails

Definition at line 119 of file Uuid.cpp.

{
   const size_t length = str.length();
 
   if (length == 0)
      return {};
 
   const bool hasBraces = str[0] == '{';
 
   if (hasBraces && (length != BRACED_UUID_LENGTH || str.back() != '}'))
      return {};
   else if (!hasBraces && length != UUID_LENGTH)
      return {};
 
   const unsigned int iteratorOffset = hasBraces ? 1 : 0;
 
   std::string::const_iterator currentSymbol = str.begin() + iteratorOffset;
   std::string::const_iterator inputEnd = str.end() - iteratorOffset;
 
   Uuid uuid;
   Bytes::iterator currentByte = uuid.mData.begin();
 
   for (int i = 0; i < 16; ++i)
   {
      if (!readByte(currentByte, currentSymbol, inputEnd))
         return {};
 
      if (currentSymbol != inputEnd && *currentSymbol == '-')
         ++currentSymbol;
   }
 
   return uuid;
}

References audacity::BRACED_UUID_LENGTH, mData, audacity::anonymous_namespace{Uuid.cpp}::readByte(), str, and audacity::UUID_LENGTH.

Here is the call graph for this function:

Generate()

Uuid Uuid::Generate ( )

static

Generate a new UUID.

Definition at line 82 of file Uuid.cpp.

{
#if defined(USE_UUID_CREATE)
   UUID winUid;
 
   if (RPC_S_OK != ::UuidCreate(&winUid))
      return {};
 
   Uuid uuid;
 
   std::memcpy(uuid.mData.data(), &winUid, sizeof(winUid));
 
   return uuid;
#elif defined(USE_CFUUID)
   CFUUIDBytes bytes = CFUUIDGetUUIDBytes(
      CF_ptr<CFUUIDRef>{ CFUUIDCreate(NULL) }.get());
 
   Uuid uuid;
 
   std::memcpy(uuid.mData.data(), &bytes, sizeof(bytes));
 
   return uuid;
#elif defined(USE_LIBUUID)
   uuid_t newId;
 
   uuid_generate(newId);
 
   Uuid uuid;
 
   std::memcpy(uuid.mData.data(), newId, sizeof(newId));
 
   return uuid;
#else
#   error "UUID generator is not defined"
#endif
}

References mData.

Referenced by audacity::sentry::anonymous_namespace{SentryReport.cpp}::CreateSentryDocument().

Here is the caller graph for this function:

GetHash()

std::size_t Uuid::GetHash ( ) const

noexcept

Definition at line 252 of file Uuid.cpp.

{
   const std::hash<uint8_t> hasher;
 
   constexpr std::size_t goldenRatio = GoldenRatio<sizeof(std::size_t)>::Value;
 
   std::size_t seed = ~0;
 
   for (uint8_t byte : mData)
   {
      seed ^= hasher(seed) + goldenRatio + (seed << 6) + (seed >> 2);
   }
 
   return seed;
}

References mData.

IsNil()

bool Uuid::IsNil ( ) const

noexcept

Checks, if the UUID is nil.

Definition at line 153 of file Uuid.cpp.

{
   return std::all_of(mData.begin(), mData.end(),
                      [](uint8_t c) { return c == 0; });
}

References mData.

operator bool()

Uuid::operator bool ( ) const

explicitnoexcept

Synonymous to !isNil()

Definition at line 159 of file Uuid.cpp.

{
   return !IsNil();
}

operator!=()

bool Uuid::operator!= ( const Uuid &  other ) const

noexcept

Definition at line 169 of file Uuid.cpp.

{
   return mData != rhs.mData;
}

operator<()

bool Uuid::operator< ( const Uuid &  other ) const

noexcept

Definition at line 184 of file Uuid.cpp.

{
   return mData < rhs.mData;
}

operator<=()

bool Uuid::operator<= ( const Uuid &  other ) const

noexcept

Definition at line 189 of file Uuid.cpp.

{
   return mData <= rhs.mData;
}

operator==()

bool Uuid::operator== ( const Uuid &  other ) const

noexcept

Definition at line 164 of file Uuid.cpp.

{
   return mData == rhs.mData;
}

operator>()

bool Uuid::operator> ( const Uuid &  other ) const

noexcept

Definition at line 174 of file Uuid.cpp.

{
   return mData > rhs.mData;
}

operator>=()

bool Uuid::operator>= ( const Uuid &  other ) const

noexcept

Definition at line 179 of file Uuid.cpp.

{
   return mData >= rhs.mData;
}

ToBytes()

const Uuid::Bytes & Uuid::ToBytes ( ) const

noexcept

Get the 16 bytes long array with the raw UUID data.

Definition at line 194 of file Uuid.cpp.

{
   return mData;
}

References mData.

ToHexString()

std::string Uuid::ToHexString

(

)

const

Get a string in the xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx format.

Definition at line 215 of file Uuid.cpp.

{
   char buffer[HEX_UUID_LENGTH + 1] = {};
 
   const int bytesWritten = snprintf(
      buffer, sizeof(buffer),
      "%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x",
      mData[0], mData[1], mData[2], mData[3], mData[4], mData[5], mData[6],
      mData[7], mData[8], mData[9], mData[10], mData[11], mData[12], mData[13],
      mData[14], mData[15]);
 
   assert(bytesWritten == HEX_UUID_LENGTH);
 
   return buffer;
}

References audacity::HEX_UUID_LENGTH, and mData.

Referenced by audacity::sentry::anonymous_namespace{SentryReport.cpp}::CreateSentryDocument().

Here is the caller graph for this function:

ToString()

std::string Uuid::ToString

(

)

const

Get a string in the xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx format.

Definition at line 199 of file Uuid.cpp.

{
   char buffer[UUID_LENGTH + 1] = {};
 
   const int bytesWritten = snprintf(
      buffer, sizeof(buffer),
      "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
      mData[0], mData[1], mData[2], mData[3], mData[4], mData[5], mData[6],
      mData[7], mData[8], mData[9], mData[10], mData[11], mData[12], mData[13],
      mData[14], mData[15]);
 
   assert(bytesWritten == UUID_LENGTH);
 
   return buffer;
}

References mData, and audacity::UUID_LENGTH.

Member Data Documentation

mData

Bytes audacity::Uuid::mData

private

Definition at line 78 of file Uuid.h.

Referenced by FromString(), Generate(), GetHash(), IsNil(), ToBytes(), ToHexString(), and ToString().

---

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

• Uuid.h
• Uuid.cpp