KIID Class Reference

#include <kiid.h>

Public Member Functions
	KIID ()
	KIID (int null)
	KIID (const std::string &aString)
	KIID (const char *aString)
	KIID (const wxString &aString)
	KIID (timestamp_t aTimestamp)
void	Clone (const KIID &aUUID)
size_t	Hash () const
bool	IsLegacyTimestamp () const
timestamp_t	AsLegacyTimestamp () const
wxString	AsString () const
wxString	AsLegacyTimestampString () const
void	ConvertTimestampToUuid ()
	Change an existing time stamp based UUID into a true UUID. More...
void	Increment ()
	Generates a deterministic replacement for a given ID. More...
bool	operator== (KIID const &rhs) const
bool	operator!= (KIID const &rhs) const
bool	operator< (KIID const &rhs) const
bool	operator> (KIID const &rhs) const

Static Public Member Functions
static bool	SniffTest (const wxString &aCandidate)
	Returns true if a string has the correct formatting to be a KIID. More...
static void	CreateNilUuids (bool aNil=true)
	A performance optimization which disables/enables the generation of pseudo-random UUIDs. More...
static void	SeedGenerator (unsigned int aSeed)
	Re-initialize the UUID generator with a given seed (for testing or QA purposes) More...

Private Attributes
boost::uuids::uuid	m_uuid
timestamp_t	m_cached_timestamp

Detailed Description

Definition at line 47 of file kiid.h.

Constructor & Destructor Documentation

KIID() [1/6]

KIID::KIID

(

)

Definition at line 74 of file kiid.cpp.

{
 m_cached_timestamp = 0;
 
#if BOOST_VERSION >= 106700
 try
 {
#endif
 
 if( g_createNilUuids )
 {
 m_uuid = nilGenerator();
 }
 else
 {
 std::lock_guard<std::mutex> lock( rng_mutex );
 m_uuid = randomGenerator();
 }
 
#if BOOST_VERSION >= 106700
 }
 catch( const boost::uuids::entropy_error& )
 {
 wxLogFatalError( "A Boost UUID entropy exception was thrown in %s:%s.",
 __FILE__, __FUNCTION__ );
 }
#endif
}

References g_createNilUuids, m_cached_timestamp, m_uuid, nilGenerator, randomGenerator, and rng_mutex.

KIID() [2/6]

KIID::KIID

(

int

null

)

Definition at line 104 of file kiid.cpp.

 :
 m_uuid( nilGenerator() ),
 m_cached_timestamp( 0 )
{
 wxASSERT( null == 0 );
}

KIID() [3/6]

KIID::KIID

(

const std::string &

aString

)

Definition at line 112 of file kiid.cpp.

 :
 m_uuid(),
 m_cached_timestamp( 0 )
{
 if( aString.length() == 8
 && std::all_of( aString.begin(), aString.end(),
 []( unsigned char c )
 {
 return std::isxdigit( c );
 } ) )
 {
 // A legacy-timestamp-based UUID has only the last 4 octets filled in.
 // Convert them individually to avoid stepping in the little-endian/big-endian
 // doo-doo.
 for( int i = 0; i < 4; ++i )
 {
 std::string octet = aString.substr( i * 2, 2 );
 m_uuid.data[i + 12] = strtol( octet.data(), nullptr, 16 );
 }
 
 m_cached_timestamp = strtol( aString.c_str(), nullptr, 16 );
 }
 else
 {
 try
 {
 m_uuid = stringGenerator( aString );
 
 if( IsLegacyTimestamp() )
 m_cached_timestamp = strtol( aString.substr( 28 ).c_str(), nullptr, 16 );
 }
 catch( ... )
 {
 // Failed to parse string representation; best we can do is assign a new
 // random one.
#if BOOST_VERSION >= 106700
 try
 {
#endif
 
 m_uuid = randomGenerator();
 
#if BOOST_VERSION >= 106700
 }
 catch( const boost::uuids::entropy_error& )
 {
 wxLogFatalError( "A Boost UUID entropy exception was thrown in %s:%s.",
 __FILE__, __FUNCTION__ );
 }
#endif
 }
 }
}

References IsLegacyTimestamp(), m_cached_timestamp, m_uuid, randomGenerator, and stringGenerator.

KIID() [4/6]

KIID::KIID

(

const char *

aString

)

Definition at line 167 of file kiid.cpp.

 :
 KIID( std::string( aString ) )
{
}

KIID() [5/6]

KIID::KIID

(

const wxString &

aString

)

Definition at line 173 of file kiid.cpp.

 :
 KIID( std::string( aString.ToUTF8() ) )
{
}

KIID() [6/6]

KIID::KIID

(

timestamp_t

aTimestamp

)

Definition at line 207 of file kiid.cpp.

{
 m_cached_timestamp = aTimestamp;
 
 // A legacy-timestamp-based UUID has only the last 4 octets filled in.
 // Convert them individually to avoid stepping in the little-endian/big-endian
 // doo-doo.
 wxString str = AsLegacyTimestampString();
 
 for( int i = 0; i < 4; ++i )
 {
 wxString octet = str.substr( i * 2, 2 );
 m_uuid.data[i + 12] = strtol( octet.data(), nullptr, 16 );
 }
}

References AsLegacyTimestampString(), m_cached_timestamp, and m_uuid.

Member Function Documentation

AsLegacyTimestamp()

timestamp_t KIID::AsLegacyTimestamp

(

)

const

Definition at line 230 of file kiid.cpp.

{
 return m_cached_timestamp;
}

References m_cached_timestamp.

Referenced by AsLegacyTimestampString(), SCH_LEGACY_PLUGIN::saveSheet(), and SCH_LEGACY_PLUGIN::saveSymbol().

AsLegacyTimestampString()

wxString KIID::AsLegacyTimestampString

(

)

const

Definition at line 263 of file kiid.cpp.

{
 return wxString::Format( "%8.8lX", (unsigned long) AsLegacyTimestamp() );
}

References AsLegacyTimestamp(), and Format().

Referenced by KIID(), and SCH_LEGACY_PLUGIN::saveSymbol().

AsString()

wxString KIID::AsString

(

)

const

Definition at line 257 of file kiid.cpp.

{
 return boost::uuids::to_string( m_uuid );
}

References m_uuid.

Referenced by SCH_SYMBOL::AddHierarchicalReference(), KIID_PATH::AsString(), SCHEMATIC::ConvertRefsToKIIDs(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), PCB_PLUGIN::format(), SCH_SEXPR_PLUGIN::Format(), formatArc(), formatBezier(), formatCircle(), formatPoly(), formatRect(), SCH_PIN::GetDefaultNetName(), SCH_REFERENCE::GetFullPath(), PAD::GetMsgPanelInfo(), FP_SHAPE::GetParentAsString(), FP_TEXT::GetParentAsString(), FP_TEXTBOX::GetParentAsString(), PAD::GetParentAsString(), PROJECT::GetSheetName(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_SHEET_PATH::PathAsString(), SCH_SYMBOL::RemoveInstance(), SCH_SYMBOL::ReplaceInstanceSheetPath(), PCB_PARSER::resolveGroups(), SCH_SEXPR_PLUGIN::saveBitmap(), SCH_SEXPR_PLUGIN::saveBusEntry(), SCH_SEXPR_PLUGIN::saveJunction(), SCH_SEXPR_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveNoConnect(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN::saveTextBox(), SniffTest(), testGroupEqual(), to_json(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

Clone()

void KIID::Clone

(

const KIID &

aUUID

)

Definition at line 250 of file kiid.cpp.

{
 m_uuid = aUUID.m_uuid;
 m_cached_timestamp = aUUID.m_cached_timestamp;
}

References m_cached_timestamp, and m_uuid.

ConvertTimestampToUuid()

void KIID::ConvertTimestampToUuid

(

)

Change an existing time stamp based UUID into a true UUID.

If this is not a time stamp based UUID, then no change is made.

Definition at line 269 of file kiid.cpp.

{
 if( !IsLegacyTimestamp() )
 return;
 
 m_cached_timestamp = 0;
 m_uuid = randomGenerator();
}

References IsLegacyTimestamp(), m_cached_timestamp, m_uuid, and randomGenerator.

CreateNilUuids()

void KIID::CreateNilUuids ( bool  aNil = true )

static

A performance optimization which disables/enables the generation of pseudo-random UUIDs.

NB: uses a global. Not thread safe!

Definition at line 294 of file kiid.cpp.

{
 g_createNilUuids = aNil;
}

References g_createNilUuids.

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), KIID_NIL_SET_RESET::KIID_NIL_SET_RESET(), SYMBOL_VIEWER_FRAME::loadAllLibraries(), and KIID_NIL_SET_RESET::~KIID_NIL_SET_RESET().

Hash()

size_t KIID::Hash

(

)

const

Definition at line 236 of file kiid.cpp.

{
 size_t hash = 0;
 
 // Note: this is NOT little-endian/big-endian safe, but as long as it's just used
 // at runtime it won't matter.
 
 for( int i = 0; i < 4; ++i )
 boost::hash_combine( hash, reinterpret_cast<const uint32_t*>( m_uuid.data )[i] );
 
 return hash;
}

References hash_combine(), and m_uuid.

Referenced by BOOST_AUTO_TEST_CASE().

Increment()

void KIID::Increment

(

)

Generates a deterministic replacement for a given ID.

NB: destroys uniform distribution! But it's the only thing we have when a deterministic replacement for a duplicate ID is required.

Definition at line 279 of file kiid.cpp.

{
 // This obviously destroys uniform distribution, but it can be useful when a
 // deterministic replacement for a duplicate ID is required.
 
 for( int i = 15; i >= 0; --i )
 {
 m_uuid.data[i]++;
 
 if( m_uuid.data[i] != 0 )
 break;
 }
}

References m_uuid.

IsLegacyTimestamp()

bool KIID::IsLegacyTimestamp

(

)

const

Definition at line 224 of file kiid.cpp.

{
 return !m_uuid.data[8] && !m_uuid.data[9] && !m_uuid.data[10] && !m_uuid.data[11];
}

References m_uuid.

Referenced by ConvertTimestampToUuid(), and KIID().

operator!=()

bool KIID::operator!= ( KIID const &  rhs ) const

inline

Definition at line 110 of file kiid.h.

 {
 return m_uuid != rhs.m_uuid;
 }

References m_uuid.

operator<()

bool KIID::operator< ( KIID const &  rhs ) const

inline

Definition at line 115 of file kiid.h.

 {
 return m_uuid < rhs.m_uuid;
 }

References m_uuid.

operator==()

bool KIID::operator== ( KIID const &  rhs ) const

inline

Definition at line 105 of file kiid.h.

 {
 return m_uuid == rhs.m_uuid;
 }

References m_uuid.

operator>()

bool KIID::operator> ( KIID const &  rhs ) const

inline

Definition at line 120 of file kiid.h.

 {
 return m_uuid > rhs.m_uuid;
 }

References m_uuid.

SeedGenerator()

void KIID::SeedGenerator ( unsigned int  aSeed )

static

Re-initialize the UUID generator with a given seed (for testing or QA purposes)

WARNING: Do not call this function from within KiCad or via a Python action plugin. It is only to be used inside QA tests or in external Python scripts. Resetting the UUID generator in the middle of a KiCad GUI run will potentially have harmful effects on file integrity.

Parameters

aSeed

is a seed to pass to the boost::mt19937 pseudo-random number generator

Definition at line 300 of file kiid.cpp.

{
 rng.seed( aSeed );
 randomGenerator = boost::uuids::basic_random_generator<boost::mt19937>( rng );
}

References randomGenerator, and rng.

Referenced by BOOST_AUTO_TEST_CASE().

SniffTest()

bool KIID::SniffTest ( const wxString &  aCandidate )

static

Returns true if a string has the correct formatting to be a KIID.

Definition at line 179 of file kiid.cpp.

{
 static wxString niluuidStr = niluuid.AsString();
 
 if( aCandidate.Length() != niluuidStr.Length() )
 return false;
 
 for( wxChar c : aCandidate )
 {
 if( c >= '0' && c <= '9' )
 continue;
 
 if( c >= 'a' && c <= 'f' )
 continue;
 
 if( c >= 'A' && c <= 'F' )
 continue;
 
 if( c == '-' )
 continue;
 
 return false;
 }
 
 return true;
}

References AsString(), and niluuid.

Referenced by searchAreas().

Member Data Documentation

m_cached_timestamp

timestamp_t KIID::m_cached_timestamp

private

Definition at line 128 of file kiid.h.

Referenced by AsLegacyTimestamp(), Clone(), ConvertTimestampToUuid(), and KIID().

m_uuid

boost::uuids::uuid KIID::m_uuid

private

Definition at line 126 of file kiid.h.

Referenced by AsString(), Clone(), ConvertTimestampToUuid(), Hash(), Increment(), IsLegacyTimestamp(), KIID(), operator!=(), operator<(), operator==(), and operator>().

---

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

• kiid.h
• kiid.cpp