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 <ian.s.mcinerney@ieee.org>
5  * Copyright (C) 2007-2014 Jean-Pierre Charras, jp.charras at wanadoo.fr
6  * Copyright (C) 1992-2020 KiCad Developers, see CHANGELOG.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 
62  static bool SniffTest( const wxString& aCandidate );
63 
70 
71  bool operator==( KIID const& rhs ) const
72  {
73  return m_uuid == rhs.m_uuid;
74  }
75 
76  bool operator!=( KIID const& rhs ) const
77  {
78  return m_uuid != rhs.m_uuid;
79  }
80 
81  bool operator<( KIID const& rhs ) const
82  {
83  return m_uuid < rhs.m_uuid;
84  }
85 
86 private:
87  boost::uuids::uuid m_uuid;
88 
90 };
91 
92 
93 extern KIID niluuid;
94 
95 KIID& NilUuid();
96 
97 // declare KIID_VECT_LIST as std::vector<KIID> both for c++ and swig:
98 DECL_VEC_FOR_SWIG( KIID_VECT_LIST, KIID )
99 
100 class KIID_PATH : public KIID_VECT_LIST
101 {
102 public:
104  {
105  }
106 
107  KIID_PATH( const wxString& aString );
108 
109 
110  wxString AsString() const;
111 
112  bool operator==( KIID_PATH const& rhs ) const
113  {
114  if( size() != rhs.size() )
115  return false;
116 
117  for( size_t i = 0; i < size(); ++i )
118  {
119  if( at( i ) != rhs.at( i ) )
120  return false;
121  }
122 
123  return true;
124  }
125 
126  bool operator<( KIID_PATH const& rhs ) const
127  {
128  if( size() != rhs.size() )
129  return size() < rhs.size();
130 
131  for( size_t i = 0; i < size(); ++i )
132  {
133  if( at( i ) < rhs.at( i ) )
134  return true;
135 
136  if( at( i ) != rhs.at( i ) )
137  return false;
138  }
139 
140  return false;
141  }
142 };
143 
144 #endif // KIID_H
KIID()
Definition: kiid.cpp:51
bool operator!=(KIID const &rhs) const
Definition: kiid.h:76
bool operator==(KIID const &rhs) const
Definition: kiid.h:71
wxString AsString() const
Definition: kiid.cpp:174
boost::uuids::uuid m_uuid
Definition: kiid.h:87
KIID niluuid
bool operator==(KIID_PATH const &rhs) const
Definition: kiid.h:112
bool IsLegacyTimestamp() const
Definition: kiid.cpp:141
timestamp_t m_cached_timestamp
Definition: kiid.h:89
bool operator<(KIID const &rhs) const
Definition: kiid.h:81
Definition: kiid.h:44
size_t Hash() const
Definition: kiid.cpp:153
KIID & NilUuid()
Definition: kiid.cpp:44
KIID_PATH()
Definition: kiid.h:103
timestamp_t AsLegacyTimestamp() const
Definition: kiid.cpp:147
static bool SniffTest(const wxString &aCandidate)
Definition: kiid.cpp:96
_OUT_STRING AsString(const std::string &aString)
Definition: sexpr.h:130
void ConvertTimestampToUuid()
Change an existing time stamp based UUID into a true UUID.
Definition: kiid.cpp:186
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:167
wxString AsLegacyTimestampString() const
Definition: kiid.cpp:180
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:126