KIID Class Reference

#include <kiid.h>

Public Member Functions
	KIID ()
	KIID (int null)
	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...
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)
static void	CreateNilUuids (bool aNil=true)

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

Detailed Description

Definition at line 44 of file kiid.h.

Constructor & Destructor Documentation

KIID() [1/4]

KIID::KIID

(

)

Definition at line 61 of file kiid.cpp.

{
    m_cached_timestamp = 0;

#if BOOST_VERSION >= 106700
    try
    {
#endif

        if( createNilUuids )
            m_uuid = nilGenerator();
        else
            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 createNilUuids, m_cached_timestamp, m_uuid, nilGenerator, and randomGenerator.

KIID() [2/4]

KIID::KIID

(

int

null

)

Definition at line 86 of file kiid.cpp.

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

KIID() [3/4]

KIID::KIID

(

const wxString &

aString

)

Definition at line 92 of file kiid.cpp.

                                    : m_uuid(), m_cached_timestamp( 0 )
{
    if( aString.length() == 8 )
    {
        // 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 )
        {
            wxString 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.wc_str() );

            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/4]

KIID::KIID

(

timestamp_t

aTimestamp

)

Definition at line 168 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 191 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 224 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 218 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_SEXPR_PLUGIN::Format(), PCB_IO::format(), FormatProbeItem(), SCH_PIN::GetDefaultNetName(), PAD::GetMsgPanelInfo(), FP_TEXT::GetParentAsString(), PAD::GetParentAsString(), FP_SHAPE::GetParentAsString(), SCH_REFERENCE::GetPath(), PROJECT::GetSheetName(), PNS::LOGGER::Log(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_SHEET_PATH::PathAsString(), SCH_SYMBOL::ReplaceInstanceSheetPath(), PCB_PARSER::resolveGroups(), SCH_SEXPR_PLUGIN::saveBitmap(), SCH_SEXPR_PLUGIN::saveBusEntry(), SCH_SEXPR_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveNoConnect(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN::saveSymbol(), SCH_SEXPR_PLUGIN::saveText(), SniffTest(), testGroupEqual(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

Clone()

void KIID::Clone

(

const KIID &

aUUID

)

Definition at line 211 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 230 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

Definition at line 240 of file kiid.cpp.

{
    createNilUuids = aNil;
}

References createNilUuids.

Referenced by FOOTPRINT_ASYNC_LOADER::Abort(), SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), and FOOTPRINT_ASYNC_LOADER::Start().

Hash()

size_t KIID::Hash

(

)

const

Definition at line 197 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.

IsLegacyTimestamp()

bool KIID::IsLegacyTimestamp

(

)

const

Definition at line 185 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 78 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 83 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 73 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 88 of file kiid.h.

    {
        return m_uuid > rhs.m_uuid;
    }

References m_uuid.

SniffTest()

bool KIID::SniffTest ( const wxString &  aCandidate )

static

Definition at line 140 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 insideArea().

Member Data Documentation

m_cached_timestamp

timestamp_t KIID::m_cached_timestamp

private

Definition at line 96 of file kiid.h.

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

m_uuid

boost::uuids::uuid KIID::m_uuid

private

Definition at line 94 of file kiid.h.

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

---

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

• kiid.h
• kiid.cpp