haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Split KIID out of common.h

This commit is contained in:
Marek Roszko 2020-10-24 00:00:49 -04:00
parent 4d5796fb9a
commit 64484f5fc4
13 changed files with 366 additions and 300 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
common/CMakeLists.txt
View File

@ -343,6 +343,7 @@ set( COMMON_SRCS
hotkeys_basic.cpp hotkeys_basic.cpp
html_messagebox.cpp html_messagebox.cpp
kiface_i.cpp kiface_i.cpp
kiid.cpp
kiway.cpp kiway.cpp
kiway_express.cpp kiway_express.cpp
kiway_holder.cpp kiway_holder.cpp

170
common/common.cpp
View File

@ -35,176 +35,6 @@
#include <wx/stdpaths.h> #include <wx/stdpaths.h>
#include <wx/url.h> #include <wx/url.h>
#include <wx/wx.h> #include <wx/wx.h>
#include <boost/uuid/uuid_generators.hpp>
#include <boost/uuid/uuid_io.hpp>
#include <boost/functional/hash.hpp>
// Create only once, as seeding is *very* expensive
static boost::uuids::random_generator randomGenerator;
// These don't have the same performance penalty, but might as well be consistent
static boost::uuids::string_generator stringGenerator;
static boost::uuids::nil_generator nilGenerator;
// Global nil reference
KIID niluuid( 0 );
// For static initialization
KIID& NilUuid()
{
static KIID nil( 0 );
return nil;
}
KIID::KIID() :
m_uuid( randomGenerator() ),
m_cached_timestamp( 0 )
{
}
KIID::KIID( int null ) :
m_uuid( nilGenerator() ),
m_cached_timestamp( 0 )
{
wxASSERT( null == 0 );
}
KIID::KIID( const wxString& aString ) :
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(), NULL, 16 );
}
m_cached_timestamp = strtol( aString.c_str(), NULL, 16 );
}
else
{
try
{
m_uuid = stringGenerator( aString.wc_str() );
if( IsLegacyTimestamp() )
m_cached_timestamp = strtol( aString.substr( 28 ).c_str(), NULL, 16 );
}
catch( ... )
{
// Failed to parse string representation; best we can do is assign a new
// random one.
m_uuid = randomGenerator();
}
}
}
bool KIID::SniffTest( const wxString& aCandidate )
{
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;
return false;
}
return true;
}
KIID::KIID( timestamp_t aTimestamp )
{
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(), NULL, 16 );
}
}
bool KIID::IsLegacyTimestamp() const
{
return !m_uuid.data[8] && !m_uuid.data[9] && !m_uuid.data[10] && !m_uuid.data[11];
}
timestamp_t KIID::AsLegacyTimestamp() const
{
return m_cached_timestamp;
}
size_t KIID::Hash() const
{
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;
}
void KIID::Clone( const KIID& aUUID )
{
m_uuid = aUUID.m_uuid;
m_cached_timestamp = aUUID.m_cached_timestamp;
}
wxString KIID::AsString() const
{
return boost::uuids::to_string( m_uuid );
}
wxString KIID::AsLegacyTimestampString() const
{
return wxString::Format( "%8.8lX", (unsigned long) AsLegacyTimestamp() );
}
void KIID::ConvertTimestampToUuid()
{
if( !IsLegacyTimestamp() )
return;
m_cached_timestamp = 0;
m_uuid = randomGenerator();
}
bool IsImperialUnit( EDA_UNITS aUnit ) bool IsImperialUnit( EDA_UNITS aUnit )

1
common/eda_doc.cpp
View File

@ -27,6 +27,7 @@
*/ */
#include <pgm_base.h> #include <pgm_base.h>
#include <common.h>
#include <confirm.h> #include <confirm.h>
#include <gestfich.h> #include <gestfich.h>
#include <settings/common_settings.h> #include <settings/common_settings.h>

1
common/gestfich.cpp
View File

@ -34,6 +34,7 @@
#include <wx/filedlg.h> #include <wx/filedlg.h>
#include <pgm_base.h> #include <pgm_base.h>
#include <common.h>
#include <confirm.h> #include <confirm.h>
#include <gestfich.h> #include <gestfich.h>

211
common/kiid.cpp Normal file
View File

@ -0,0 +1,211 @@
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2020 Ian McInerney <ian.s.mcinerney@ieee.org>
* Copyright (C) 2007-2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 1992-2020 KiCad Developers, see CHANGELOG.TXT for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#include <common.h> // AsLegacyTimestampString, AsString
#include <kiid.h>
#include <boost/uuid/uuid_generators.hpp>
#include <boost/uuid/uuid_io.hpp>
#include <boost/functional/hash.hpp>
// Create only once, as seeding is *very* expensive
static boost::uuids::random_generator randomGenerator;
// These don't have the same performance penalty, but might as well be consistent
static boost::uuids::string_generator stringGenerator;
static boost::uuids::nil_generator nilGenerator;
// Global nil reference
KIID niluuid( 0 );
// For static initialization
KIID& NilUuid()
{
static KIID nil( 0 );
return nil;
}
KIID::KIID() : m_uuid( randomGenerator() ), m_cached_timestamp( 0 )
{
}
KIID::KIID( int null ) : m_uuid( nilGenerator() ), m_cached_timestamp( 0 )
{
wxASSERT( null == 0 );
}
KIID::KIID( const wxString& aString ) : 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(), NULL, 16 );
}
m_cached_timestamp = strtol( aString.c_str(), NULL, 16 );
}
else
{
try
{
m_uuid = stringGenerator( aString.wc_str() );
if( IsLegacyTimestamp() )
m_cached_timestamp = strtol( aString.substr( 28 ).c_str(), NULL, 16 );
}
catch( ... )
{
// Failed to parse string representation; best we can do is assign a new
// random one.
m_uuid = randomGenerator();
}
}
}
bool KIID::SniffTest( const wxString& aCandidate )
{
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;
return false;
}
return true;
}
KIID::KIID( timestamp_t aTimestamp )
{
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(), NULL, 16 );
}
}
bool KIID::IsLegacyTimestamp() const
{
return !m_uuid.data[8] && !m_uuid.data[9] && !m_uuid.data[10] && !m_uuid.data[11];
}
timestamp_t KIID::AsLegacyTimestamp() const
{
return m_cached_timestamp;
}
size_t KIID::Hash() const
{
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;
}
void KIID::Clone( const KIID& aUUID )
{
m_uuid = aUUID.m_uuid;
m_cached_timestamp = aUUID.m_cached_timestamp;
}
wxString KIID::AsString() const
{
return boost::uuids::to_string( m_uuid );
}
wxString KIID::AsLegacyTimestampString() const
{
return wxString::Format( "%8.8lX", (unsigned long) AsLegacyTimestamp() );
}
void KIID::ConvertTimestampToUuid()
{
if( !IsLegacyTimestamp() )
return;
m_cached_timestamp = 0;
m_uuid = randomGenerator();
}
KIID_PATH::KIID_PATH( const wxString& aString )
{
for( const wxString& pathStep : wxSplit( aString, '/' ) )
{
if( !pathStep.empty() )
emplace_back( KIID( pathStep ) );
}
}
wxString KIID_PATH::AsString() const
{
wxString path;
for( const KIID& pathStep : *this )
path += '/' + pathStep.AsString();
return path;
}

1
common/plugins/eagle/eagle_parser.h
View File

@ -29,6 +29,7 @@
#define _EAGLE_PARSER_H_ #define _EAGLE_PARSER_H_
#include <cerrno> #include <cerrno>
#include <map>
#include <unordered_map> #include <unordered_map>
#include <wx/xml/xml.h> #include <wx/xml/xml.h>

2
common/swig/kicad.i
View File

@ -82,6 +82,7 @@ principle should be easily implemented by adapting the current STL containers.
%{ %{
#include <outline_mode.h> #include <outline_mode.h>
#include <macros_swig.h> #include <macros_swig.h>
#include <kiid.h>
#include <cstddef> #include <cstddef>
#include <eda_item.h> #include <eda_item.h>
#include <eda_rect.h> #include <eda_rect.h>
@ -110,6 +111,7 @@ principle should be easily implemented by adapting the current STL containers.
// header files that must be wrapped // header files that must be wrapped
%include <outline_mode.h> %include <outline_mode.h>
%include macros_swig.h %include macros_swig.h
%include kiid.h
%include core/typeinfo.h %include core/typeinfo.h
%include eda_item.h %include eda_item.h
%include eda_rect.h %include eda_rect.h

126
include/common.h
View File

@ -49,139 +49,13 @@
#include <memory> #include <memory>
#include <type_traits> #include <type_traits>
#include <typeinfo> #include <typeinfo>
#include <boost/uuid/uuid.hpp>
#include <core/kicad_algo.h> #include <core/kicad_algo.h>
#include <macros.h> #include <macros.h>
#include <macros_swig.h>
class PROJECT; class PROJECT;
class SEARCH_STACK; class SEARCH_STACK;
class REPORTER; class REPORTER;
/**
* timestamp_t is our type to represent unique IDs for all kinds of elements;
* historically simply the timestamp when they were created.
*
* Long term, this type might be renamed to something like unique_id_t
* (and then rename all the methods from {Get,Set}TimeStamp()
* to {Get,Set}Id()) ?
*/
typedef uint32_t timestamp_t;
class KIID
{
public:
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;
static bool SniffTest( const wxString& aCandidate );
/**
* 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.
*/
void ConvertTimestampToUuid();
bool operator==( KIID const& rhs) const
{
return m_uuid == rhs.m_uuid;
}
bool operator!=( KIID const& rhs) const
{
return m_uuid != rhs.m_uuid;
}
bool operator<( KIID const& rhs) const
{
return m_uuid < rhs.m_uuid;
}
private:
boost::uuids::uuid m_uuid;
timestamp_t m_cached_timestamp;
};
extern KIID niluuid;
KIID& NilUuid();
// declare KIID_VECT_LIST as std::vector<KIID> both for c++ and swig:
DECL_VEC_FOR_SWIG( KIID_VECT_LIST, KIID )
class KIID_PATH : public KIID_VECT_LIST
{
public:
KIID_PATH()
{}
KIID_PATH( const wxString& aString )
{
for( const wxString& pathStep : wxSplit( aString, '/' ) )
{
if( !pathStep.empty() )
emplace_back( KIID( pathStep ) );
}
}
wxString AsString() const
{
wxString path;
for( const KIID& pathStep : *this )
path += '/' + pathStep.AsString();
return path;
}
bool operator==( KIID_PATH const& rhs) const
{
if( size() != rhs.size() )
return false;
for( size_t i = 0; i < size(); ++i )
{
if( at( i ) != rhs.at( i ) )
return false;
}
return true;
}
bool operator<( KIID_PATH const& rhs) const
{
if( size() != rhs.size() )
return size() < rhs.size();
for( size_t i = 0; i < size(); ++i )
{
if( at( i ) < rhs.at( i ) )
return true;
if( at( i ) != rhs.at( i ) )
return false;
}
return false;
}
};
/// default name for nameless projects /// default name for nameless projects
#define NAMELESS_PROJECT wxT( "noname" ) #define NAMELESS_PROJECT wxT( "noname" )

1
include/eda_item.h
View File

@ -33,6 +33,7 @@
#include <wx/fdrepdlg.h> #include <wx/fdrepdlg.h>
#include <bitmap_types.h> #include <bitmap_types.h>
#include <view/view_item.h> #include <view/view_item.h>
#include <kiid.h>

144
include/kiid.h Normal file
View File

@ -0,0 +1,144 @@
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2020 Ian McInerney <ian.s.mcinerney@ieee.org>
* Copyright (C) 2007-2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 1992-2020 KiCad Developers, see CHANGELOG.TXT for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef KIID_H
#define KIID_H
#include <boost/uuid/uuid.hpp>
#include <macros_swig.h>
class wxString;
/**
* timestamp_t is our type to represent unique IDs for all kinds of elements;
* historically simply the timestamp when they were created.
*
* Long term, this type might be renamed to something like unique_id_t
* (and then rename all the methods from {Get,Set}TimeStamp()
* to {Get,Set}Id()) ?
*/
typedef uint32_t timestamp_t;
class KIID
{
public:
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;
static bool SniffTest( const wxString& aCandidate );
/**
* 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.
*/
void ConvertTimestampToUuid();
bool operator==( KIID const& rhs ) const
{
return m_uuid == rhs.m_uuid;
}
bool operator!=( KIID const& rhs ) const
{
return m_uuid != rhs.m_uuid;
}
bool operator<( KIID const& rhs ) const
{
return m_uuid < rhs.m_uuid;
}
private:
boost::uuids::uuid m_uuid;
timestamp_t m_cached_timestamp;
};
extern KIID niluuid;
KIID& NilUuid();
// declare KIID_VECT_LIST as std::vector<KIID> both for c++ and swig:
DECL_VEC_FOR_SWIG( KIID_VECT_LIST, KIID )
class KIID_PATH : public KIID_VECT_LIST
{
public:
KIID_PATH()
{
}
KIID_PATH( const wxString& aString );
wxString AsString() const;
bool operator==( KIID_PATH const& rhs ) const
{
if( size() != rhs.size() )
return false;
for( size_t i = 0; i < size(); ++i )
{
if( at( i ) != rhs.at( i ) )
return false;
}
return true;
}
bool operator<( KIID_PATH const& rhs ) const
{
if( size() != rhs.size() )
return size() < rhs.size();
for( size_t i = 0; i < size(); ++i )
{
if( at( i ) < rhs.at( i ) )
return true;
if( at( i ) != rhs.at( i ) )
return false;
}
return false;
}
};
#endif // KIID_H

2
include/macros_swig.h
View File

@ -54,4 +54,4 @@
#define DECL_SET_FOR_SWIG(TypeName, MemberType) typedef std::set<MemberType> TypeName; #define DECL_SET_FOR_SWIG(TypeName, MemberType) typedef std::set<MemberType> TypeName;
#endif #endif
#endif // MACROS2_H #endif // MACROS_SWIG_H

4
include/project.h
View File

@ -26,12 +26,12 @@
/** /**
* @file project.h * @file project.h
*/ */
#include <map>
#include <vector> #include <vector>
#include <kiid.h>
#include <wx/string.h> #include <wx/string.h>
#include <wx/filename.h> #include <wx/filename.h>
#include <core/typeinfo.h> #include <core/typeinfo.h>
#include <common.h>
/// A variable name whose value holds the current project directory. /// A variable name whose value holds the current project directory.
/// Currently an environment variable, eventually a project variable. /// Currently an environment variable, eventually a project variable.

2
pcbnew/netinfo.h
View File

@ -29,7 +29,7 @@
#ifndef CLASS_NETINFO_ #ifndef CLASS_NETINFO_
#define CLASS_NETINFO_ #define CLASS_NETINFO_
#include <macros.h> #include <macros_swig.h>
#include <gr_basic.h> #include <gr_basic.h>
#include <netclass.h> #include <netclass.h>
#include <class_board_item.h> #include <class_board_item.h>