KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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-2023 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 <kicommon.h>
30#include <boost/uuid/uuid.hpp>
31#include <macros_swig.h>
32#include <nlohmann/json_fwd.hpp>
33
34#include <string>
35
36class wxString;
37
46typedef uint32_t timestamp_t;
47
49{
50public:
51 KIID();
52 KIID( int null );
53 KIID( const std::string& aString );
54 KIID( const char* aString );
55 KIID( const wxString& aString );
56 KIID( timestamp_t aTimestamp );
57
58 void Clone( const KIID& aUUID );
59
60 size_t Hash() const;
61
62 bool IsLegacyTimestamp() const;
63 timestamp_t AsLegacyTimestamp() const;
64
65 wxString AsString() const;
66 wxString AsLegacyTimestampString() const;
67 std::string AsStdString() const;
68
72 static bool SniffTest( const wxString& aCandidate );
73
79 static void CreateNilUuids( bool aNil = true );
80
90 static void SeedGenerator( unsigned int aSeed );
91
97 void ConvertTimestampToUuid();
98
105 void Increment();
106
107 bool operator==( KIID const& rhs ) const
108 {
109 return m_uuid == rhs.m_uuid;
110 }
111
112 bool operator!=( KIID const& rhs ) const
113 {
114 return m_uuid != rhs.m_uuid;
115 }
116
117 bool operator<( KIID const& rhs ) const
118 {
119 return m_uuid < rhs.m_uuid;
120 }
121
122 bool operator>( KIID const& rhs ) const
123 {
124 return m_uuid > rhs.m_uuid;
125 }
126
127private:
128 boost::uuids::uuid m_uuid;
129};
130
131
133
135
136// declare KIID_VECT_LIST as std::vector<KIID> both for c++ and swig:
137DECL_VEC_FOR_SWIG( KIID_VECT_LIST, KIID )
138
139class KICOMMON_API KIID_PATH : public KIID_VECT_LIST
140{
141public:
143 {
144 }
145
146 KIID_PATH( const wxString& aString );
147
148 bool MakeRelativeTo( const KIID_PATH& aPath );
149
159 bool EndsWith( const KIID_PATH& aPath ) const;
160
161 wxString AsString() const;
162
163 bool operator==( KIID_PATH const& rhs ) const
164 {
165 if( size() != rhs.size() )
166 return false;
167
168 for( size_t i = 0; i < size(); ++i )
169 {
170 if( at( i ) != rhs.at( i ) )
171 return false;
172 }
173
174 return true;
175 }
176
177 bool operator<( KIID_PATH const& rhs ) const
178 {
179 if( size() != rhs.size() )
180 return size() < rhs.size();
181
182 for( size_t i = 0; i < size(); ++i )
183 {
184 if( at( i ) < rhs.at( i ) )
185 return true;
186
187 if( at( i ) != rhs.at( i ) )
188 return false;
189 }
190
191 return false;
192 }
193
195 {
196 for( const KIID& kiid : aRhs )
197 emplace_back( kiid );
198
199 return *this;
200 }
201
202 friend KIID_PATH operator+( KIID_PATH aLhs, const KIID_PATH& aRhs )
203 {
204 aLhs += aRhs;
205 return aLhs;
206 }
207};
208
213{
214public:
216 {
217 KIID::CreateNilUuids( true );
218 };
219
221 {
222 KIID::CreateNilUuids( false );
223 }
224};
225
226KICOMMON_API void to_json( nlohmann::json& aJson, const KIID& aKIID );
227
228KICOMMON_API void from_json( const nlohmann::json& aJson, KIID& aKIID );
229
230template<> struct KICOMMON_API std::hash<KIID>
231{
232 std::size_t operator()( const KIID& aId ) const
233 {
234 return aId.Hash();
235 }
236};
237
238#endif // KIID_H
RAII class to safely set/reset nil KIIDs for use in footprint/symbol loading.
Definition: kiid.h:213
KIID_NIL_SET_RESET()
Definition: kiid.h:215
~KIID_NIL_SET_RESET()
Definition: kiid.h:220
KIID_PATH & operator+=(const KIID_PATH &aRhs)
Definition: kiid.h:194
bool operator==(KIID_PATH const &rhs) const
Definition: kiid.h:163
KIID_PATH()
Definition: kiid.h:142
bool operator<(KIID_PATH const &rhs) const
Definition: kiid.h:177
friend KIID_PATH operator+(KIID_PATH aLhs, const KIID_PATH &aRhs)
Definition: kiid.h:202
Definition: kiid.h:49
size_t Hash() const
Definition: kiid.cpp:226
boost::uuids::uuid m_uuid
Definition: kiid.h:128
bool operator>(KIID const &rhs) const
Definition: kiid.h:122
static void CreateNilUuids(bool aNil=true)
A performance optimization which disables/enables the generation of pseudo-random UUIDs.
Definition: kiid.cpp:288
bool operator!=(KIID const &rhs) const
Definition: kiid.h:112
bool operator==(KIID const &rhs) const
Definition: kiid.h:107
bool operator<(KIID const &rhs) const
Definition: kiid.h:117
#define KICOMMON_API
Definition: kicommon.h:28
KICOMMON_API KIID & NilUuid()
Definition: kiid.cpp:67
KICOMMON_API void from_json(const nlohmann::json &aJson, KIID &aKIID)
Definition: kiid.cpp:373
KICOMMON_API void to_json(nlohmann::json &aJson, const KIID &aKIID)
Definition: kiid.cpp:367
KICOMMON_API KIID niluuid
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:46
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
STL namespace.
std::size_t operator()(const KIID &aId) const
Definition: kiid.h:232