KiCad PCB EDA Suite
lib_id.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) 2010-2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
5  * Copyright (C) 2012 Wayne Stambaugh <stambaughw@gmail.com>
6  * Copyright (C) 2010-2018 KiCad Developers, see change_log.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 _LIB_ID_H_
27 #define _LIB_ID_H_
28 
29 #include <richio.h>
30 #include <utf8.h>
31 
51 class LIB_ID
52 {
53 public:
54 
57 
58  LIB_ID() {}
59 
60  // NOTE: don't define any constructors which call Parse() on their arguments. We want it
61  // to be obvious to callers that parsing is involved (and that valid IDs are guaranteed in
62  // the presence of disallowed characters, malformed ids, etc.).
63 
74  LIB_ID( const wxString& aLibName, const wxString& aLibItemName,
75  const wxString& aRevision = wxEmptyString );
76 
92  int Parse( const UTF8& aId, LIB_ID_TYPE aType, bool aFix = false );
93 
97  const UTF8& GetLibNickname() const
98  {
99  return nickname;
100  }
101 
109  int SetLibNickname( const UTF8& aNickname );
110 
114  const UTF8& GetLibItemName() const { return item_name; }
115 
121  const wxString GetUniStringLibItemName() const { return item_name.wx_str(); }
122 
130  int SetLibItemName( const UTF8& aLibItemName, bool aTestForRev = true );
131 
132  int SetRevision( const UTF8& aRevision );
133 
134  const UTF8& GetRevision() const { return revision; }
135 
136  UTF8 GetLibItemNameAndRev() const;
137 
141  UTF8 Format() const;
142 
148  wxString GetUniStringLibId() const
149  {
150  return Format().wx_str();
151  }
152 
159  static UTF8 Format( const UTF8& aLibNickname, const UTF8& aLibItemName,
160  const UTF8& aRevision = "" );
161 
171  bool IsValid() const { return !nickname.empty() && !item_name.empty(); }
172 
176  bool IsLegacy() const { return nickname.empty() && !item_name.empty() && revision.empty(); }
177 
181  void clear();
182 
186  bool empty() const { return nickname.empty() && item_name.empty() && revision.empty(); }
187 
196  int compare( const LIB_ID& aLibId ) const;
197 
198  bool operator < ( const LIB_ID& aLibId ) const { return this->compare( aLibId ) < 0; }
199  bool operator > ( const LIB_ID& aLibId ) const { return this->compare( aLibId ) > 0; }
200  bool operator ==( const LIB_ID& aLibId ) const { return this->compare( aLibId ) == 0; }
201  bool operator !=( const LIB_ID& aLibId ) const { return !(*this == aLibId); }
202 
210  static int HasIllegalChars( const UTF8& aLibItemName, LIB_ID_TYPE aType );
211 
220  static UTF8 FixIllegalChars( const UTF8& aLibItemName, LIB_ID_TYPE aType, bool aLib = false );
221 
229  static unsigned FindIllegalLibNicknameChar( const UTF8& aNickname, LIB_ID_TYPE aType );
230 
231 #if defined(DEBUG)
232  static void Test();
233 #endif
234 
235 protected:
259  static bool isLegalChar( unsigned aUniChar, LIB_ID_TYPE aType );
260 
267  static bool isLegalLibNicknameChar( unsigned aUniChar, LIB_ID_TYPE aType );
268 
272 };
273 
274 
275 #endif // _LIB_ID_H_
int compare(const LIB_ID &aLibId) const
Compare the contents of LIB_ID objects by performing a std::string comparison of the library nickname...
Definition: lib_id.cpp:316
bool IsValid() const
Definition: lib_id.h:171
bool operator>(const LIB_ID &aLibId) const
Definition: lib_id.h:199
Class UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion supp...
Definition: utf8.h:73
const wxString GetUniStringLibItemName() const
Definition: lib_id.h:121
bool empty() const
Definition: lib_id.h:186
static bool isLegalLibNicknameChar(unsigned aUniChar, LIB_ID_TYPE aType)
Tests whether a unicode character is a legal LIB_ID library nickname character.
Definition: lib_id.cpp:410
UTF8 revision
The revision of the entry.
Definition: lib_id.h:271
bool operator!=(const LIB_ID &aLibId) const
Definition: lib_id.h:201
bool operator<(const LIB_ID &aLibId) const
Definition: lib_id.h:198
static bool isLegalChar(unsigned aUniChar, LIB_ID_TYPE aType)
Tests whether a unicode character is a legal LIB_ID item name character.
Definition: lib_id.cpp:369
bool IsLegacy() const
Definition: lib_id.h:176
static unsigned FindIllegalLibNicknameChar(const UTF8 &aNickname, LIB_ID_TYPE aType)
Looks for characters that are illegal in library nicknames.
Definition: lib_id.cpp:398
static int HasIllegalChars(const UTF8 &aLibItemName, LIB_ID_TYPE aType)
Examine aLibItemName for invalid LIB_ID item name characters.
Definition: lib_id.cpp:336
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
UTF8 GetLibItemNameAndRev() const
Definition: lib_id.cpp:259
wxString GetUniStringLibId() const
Definition: lib_id.h:148
const UTF8 & GetRevision() const
Definition: lib_id.h:134
wxString wx_str() const
Definition: utf8.cpp:51
bool operator==(const LIB_ID &aLibId) const
Definition: lib_id.h:200
bool empty() const
Definition: utf8.h:108
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
UTF8 item_name
The name of the entry in the logical library.
Definition: lib_id.h:270
int SetRevision(const UTF8 &aRevision)
Definition: lib_id.cpp:224
UTF8 nickname
The nickname of the library or empty.
Definition: lib_id.h:269
void clear()
Clear the contents of the library nickname, library entry name, and revision strings.
Definition: lib_id.cpp:114
int SetLibItemName(const UTF8 &aLibItemName, bool aTestForRev=true)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:206
int SetLibNickname(const UTF8 &aNickname)
Override the logical library name portion of the LIB_ID to aNickname.
Definition: lib_id.cpp:193
LIB_ID_TYPE
Types of library identifiers
Definition: lib_id.h:56
LIB_ID()
Definition: lib_id.h:58
UTF8 Format() const
Definition: lib_id.cpp:237
static UTF8 FixIllegalChars(const UTF8 &aLibItemName, LIB_ID_TYPE aType, bool aLib=false)
Replace illegal LIB_ID item name characters with underscores &#39;_&#39;.
Definition: lib_id.cpp:352
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
int Parse(const UTF8 &aId, LIB_ID_TYPE aType, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:122