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
71 static bool SniffTest( const wxString& aCandidate );
72
78 static void CreateNilUuids( bool aNil = true );
79
89 static void SeedGenerator( unsigned int aSeed );
90
96 void ConvertTimestampToUuid();
97
104 void Increment();
105
106 bool operator==( KIID const& rhs ) const
107 {
108 return m_uuid == rhs.m_uuid;
109 }
110
111 bool operator!=( KIID const& rhs ) const
112 {
113 return m_uuid != rhs.m_uuid;
114 }
115
116 bool operator<( KIID const& rhs ) const
117 {
118 return m_uuid < rhs.m_uuid;
119 }
120
121 bool operator>( KIID const& rhs ) const
122 {
123 return m_uuid > rhs.m_uuid;
124 }
125
126private:
127 boost::uuids::uuid m_uuid;
128
130};
131
132
134
136
137// declare KIID_VECT_LIST as std::vector<KIID> both for c++ and swig:
138DECL_VEC_FOR_SWIG( KIID_VECT_LIST, KIID )
139
140class KICOMMON_API KIID_PATH : public KIID_VECT_LIST
141{
142public:
144 {
145 }
146
147 KIID_PATH( const wxString& aString );
148
149 bool MakeRelativeTo( const KIID_PATH& aPath );
150
160 bool EndsWith( const KIID_PATH& aPath ) const;
161
162 wxString AsString() const;
163
164 bool operator==( KIID_PATH const& rhs ) const
165 {
166 if( size() != rhs.size() )
167 return false;
168
169 for( size_t i = 0; i < size(); ++i )
170 {
171 if( at( i ) != rhs.at( i ) )
172 return false;
173 }
174
175 return true;
176 }
177
178 bool operator<( KIID_PATH const& rhs ) const
179 {
180 if( size() != rhs.size() )
181 return size() < rhs.size();
182
183 for( size_t i = 0; i < size(); ++i )
184 {
185 if( at( i ) < rhs.at( i ) )
186 return true;
187
188 if( at( i ) != rhs.at( i ) )
189 return false;
190 }
191
192 return false;
193 }
194
196 {
197 for( const KIID& kiid : aRhs )
198 emplace_back( kiid );
199
200 return *this;
201 }
202
203 friend KIID_PATH operator+( KIID_PATH aLhs, const KIID_PATH& aRhs )
204 {
205 aLhs += aRhs;
206 return aLhs;
207 }
208};
209
214{
215public:
217 {
218 KIID::CreateNilUuids( true );
219 };
220
222 {
223 KIID::CreateNilUuids( false );
224 }
225};
226
227KICOMMON_API void to_json( nlohmann::json& aJson, const KIID& aKIID );
228
229KICOMMON_API void from_json( const nlohmann::json& aJson, KIID& aKIID );
230
231#endif // KIID_H
RAII class to safely set/reset nil KIIDs for use in footprint/symbol loading.
Definition: kiid.h:214
KIID_NIL_SET_RESET()
Definition: kiid.h:216
~KIID_NIL_SET_RESET()
Definition: kiid.h:221
KIID_PATH & operator+=(const KIID_PATH &aRhs)
Definition: kiid.h:195
bool operator==(KIID_PATH const &rhs) const
Definition: kiid.h:164
KIID_PATH()
Definition: kiid.h:143
bool operator<(KIID_PATH const &rhs) const
Definition: kiid.h:178
friend KIID_PATH operator+(KIID_PATH aLhs, const KIID_PATH &aRhs)
Definition: kiid.h:203
Definition: kiid.h:49
timestamp_t m_cached_timestamp
Definition: kiid.h:129
boost::uuids::uuid m_uuid
Definition: kiid.h:127
bool operator>(KIID const &rhs) const
Definition: kiid.h:121
static void CreateNilUuids(bool aNil=true)
A performance optimization which disables/enables the generation of pseudo-random UUIDs.
Definition: kiid.cpp:294
bool operator!=(KIID const &rhs) const
Definition: kiid.h:111
bool operator==(KIID const &rhs) const
Definition: kiid.h:106
bool operator<(KIID const &rhs) const
Definition: kiid.h:116
#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:379
KICOMMON_API void to_json(nlohmann::json &aJson, const KIID &aKIID)
Definition: kiid.cpp:373
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