KiCad PCB EDA Suite
kiid.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2020 Ian McInerney <[email protected]>
5  * Copyright (C) 2007-2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
6  * Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.TXT for contributors.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
26 #ifndef KIID_H
27 #define KIID_H
28 
29 #include <boost/uuid/uuid.hpp>
30 #include <macros_swig.h>
31 
32 class wxString;
33 
42 typedef uint32_t timestamp_t;
43 
44 class KIID
45 {
46 public:
47  KIID();
48  KIID( int null );
49  KIID( const wxString& aString );
50  KIID( timestamp_t aTimestamp );
51 
52  void Clone( const KIID& aUUID );
53 
54  size_t Hash() const;
55 
56  bool IsLegacyTimestamp() const;
58 
59  wxString AsString() const;
60  wxString AsLegacyTimestampString() const;
61 
65  static bool SniffTest( const wxString& aCandidate );
66 
72  static void CreateNilUuids( bool aNil = true );
73 
83  static void SeedGenerator( unsigned int aSeed );
84 
91 
98  void Increment();
99 
100  bool operator==( KIID const& rhs ) const
101  {
102  return m_uuid == rhs.m_uuid;
103  }
104 
105  bool operator!=( KIID const& rhs ) const
106  {
107  return m_uuid != rhs.m_uuid;
108  }
109 
110  bool operator<( KIID const& rhs ) const
111  {
112  return m_uuid < rhs.m_uuid;
113  }
114 
115  bool operator>( KIID const& rhs ) const
116  {
117  return m_uuid > rhs.m_uuid;
118  }
119 
120 private:
121  boost::uuids::uuid m_uuid;
122 
124 };
125 
126 
127 extern KIID niluuid;
128 
129 KIID& NilUuid();
130 
131 // declare KIID_VECT_LIST as std::vector<KIID> both for c++ and swig:
132 DECL_VEC_FOR_SWIG( KIID_VECT_LIST, KIID )
133 
134 class KIID_PATH : public KIID_VECT_LIST
135 {
136 public:
138  {
139  }
140 
141  KIID_PATH( const wxString& aString );
142 
143  bool MakeRelativeTo( const KIID_PATH& aPath );
144 
145  wxString AsString() const;
146 
147  bool operator==( KIID_PATH const& rhs ) const
148  {
149  if( size() != rhs.size() )
150  return false;
151 
152  for( size_t i = 0; i < size(); ++i )
153  {
154  if( at( i ) != rhs.at( i ) )
155  return false;
156  }
157 
158  return true;
159  }
160 
161  bool operator<( KIID_PATH const& rhs ) const
162  {
163  if( size() != rhs.size() )
164  return size() < rhs.size();
165 
166  for( size_t i = 0; i < size(); ++i )
167  {
168  if( at( i ) < rhs.at( i ) )
169  return true;
170 
171  if( at( i ) != rhs.at( i ) )
172  return false;
173  }
174 
175  return false;
176  }
177 };
178 
179 #endif // KIID_H
KIID()
Definition: kiid.cpp:74
bool operator>(KIID const &rhs) const
Definition: kiid.h:115
bool operator!=(KIID const &rhs) const
Definition: kiid.h:105
bool operator==(KIID const &rhs) const
Definition: kiid.h:100
wxString AsString() const
Definition: kiid.cpp:236
boost::uuids::uuid m_uuid
Definition: kiid.h:121
KIID niluuid
bool operator==(KIID_PATH const &rhs) const
Definition: kiid.h:147
static void SeedGenerator(unsigned int aSeed)
Re-initialize the UUID generator with a given seed (for testing or QA purposes)
Definition: kiid.cpp:279
bool IsLegacyTimestamp() const
Definition: kiid.cpp:203
timestamp_t m_cached_timestamp
Definition: kiid.h:123
bool operator<(KIID const &rhs) const
Definition: kiid.h:110
Definition: kiid.h:44
size_t Hash() const
Definition: kiid.cpp:215
KIID & NilUuid()
Definition: kiid.cpp:67
KIID_PATH()
Definition: kiid.h:137
timestamp_t AsLegacyTimestamp() const
Definition: kiid.cpp:209
static bool SniffTest(const wxString &aCandidate)
Returns true if a string has the correct formatting to be a KIID.
Definition: kiid.cpp:158
_OUT_STRING AsString(const std::string &aString)
Definition: sexpr.h:131
void ConvertTimestampToUuid()
Change an existing time stamp based UUID into a true UUID.
Definition: kiid.cpp:248
uint32_t timestamp_t
timestamp_t is our type to represent unique IDs for all kinds of elements; historically simply the ti...
Definition: kiid.h:32
void Clone(const KIID &aUUID)
Definition: kiid.cpp:229
void Increment()
Generates a deterministic replacement for a given ID.
Definition: kiid.cpp:258
wxString AsLegacyTimestampString() const
Definition: kiid.cpp:242
static void CreateNilUuids(bool aNil=true)
A performance optimization which disables/enables the generation of pseudo-random UUIDs.
Definition: kiid.cpp:273
This file contains macros just for swig binding.
#define DECL_VEC_FOR_SWIG(TypeName, MemberType)
Declare a std::vector but no swig template.
Definition: macros_swig.h:50
bool operator<(KIID_PATH const &rhs) const
Definition: kiid.h:161