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-2020 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  LIB_ID() {}
55 
56  // NOTE: don't define any constructors which call Parse() on their arguments. We want it
57  // to be obvious to callers that parsing is involved (and that valid IDs are guaranteed in
58  // the presence of disallowed characters, malformed ids, etc.).
59 
70  LIB_ID( const wxString& aLibraryName, const wxString& aItemName,
71  const wxString& aRevision = wxEmptyString );
72 
87  int Parse( const UTF8& aId, bool aFix = false );
88 
92  const UTF8& GetLibNickname() const { return m_libraryName; }
93 
101  int SetLibNickname( const UTF8& aNickname );
102 
106  const UTF8& GetLibItemName() const { return m_itemName; }
107 
116  const wxString GetUniStringLibItemName() const { return m_itemName.wx_str(); }
117 
125  int SetLibItemName( const UTF8& aLibItemName, bool aTestForRev = true );
126 
127  int SetRevision( const UTF8& aRevision );
128 
129  const UTF8& GetRevision() const { return m_revision; }
130 
131  UTF8 GetLibItemNameAndRev() const;
132 
136  UTF8 Format() const;
137 
142  wxString GetUniStringLibId() const
143  {
144  return Format().wx_str();
145  }
146 
153  static UTF8 Format( const UTF8& aLibraryName, const UTF8& aLibItemName,
154  const UTF8& aRevision = "" );
155 
168  bool IsValid() const
169  {
170  return !m_libraryName.empty() && !m_itemName.empty();
171  }
172 
176  bool IsLegacy() const
177  {
178  return m_libraryName.empty() && !m_itemName.empty() && m_revision.empty();
179  }
180 
184  void clear();
185 
189  bool empty() const
190  {
191  return m_libraryName.empty() && m_itemName.empty() && m_revision.empty();
192  }
193 
201  int compare( const LIB_ID& aLibId ) const;
202 
203  bool operator < ( const LIB_ID& aLibId ) const { return this->compare( aLibId ) < 0; }
204  bool operator > ( const LIB_ID& aLibId ) const { return this->compare( aLibId ) > 0; }
205  bool operator ==( const LIB_ID& aLibId ) const { return this->compare( aLibId ) == 0; }
206  bool operator !=( const LIB_ID& aLibId ) const { return !(*this == aLibId); }
207 
214  static int HasIllegalChars( const UTF8& aLibItemName );
215 
223  static UTF8 FixIllegalChars( const UTF8& aLibItemName, bool aLib = false );
224 
231  static unsigned FindIllegalLibraryNameChar( const UTF8& aLibraryName );
232 
233 protected:
257  static bool isLegalChar( unsigned aUniChar );
258 
265  static bool isLegalLibraryNameChar( unsigned aUniChar );
266 
270 };
271 
272 
273 #endif // _LIB_ID_H_
An 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to and fro...
Definition: utf8.h:70
const UTF8 & GetLibItemName() const
Definition: lib_id.h:106
static UTF8 FixIllegalChars(const UTF8 &aLibItemName, bool aLib=false)
Replace illegal LIB_ID item name characters with underscores '_'.
Definition: lib_id.cpp:347
UTF8 m_revision
The revision of the entry.
Definition: lib_id.h:269
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
bool IsValid() const
Check if this LID_ID is valid.
Definition: lib_id.h:168
static bool isLegalLibraryNameChar(unsigned aUniChar)
Tests whether a Unicode character is a legal LIB_ID library nickname character.
Definition: lib_id.cpp:410
static bool isLegalChar(unsigned aUniChar)
Tests whether a Unicode character is a legal LIB_ID item name character.
Definition: lib_id.cpp:364
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:311
bool empty() const
Definition: lib_id.h:189
UTF8 GetLibItemNameAndRev() const
Definition: lib_id.cpp:255
bool operator !=(const LIB_ID &aLibId) const
Definition: lib_id.h:206
int SetRevision(const UTF8 &aRevision)
Definition: lib_id.cpp:222
bool operator >(const LIB_ID &aLibId) const
Definition: lib_id.h:204
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:92
void clear()
Clear the contents of the library nickname, library entry name, and revision strings.
Definition: lib_id.cpp:114
UTF8 m_libraryName
The nickname of the library or empty.
Definition: lib_id.h:267
UTF8 Format() const
Definition: lib_id.cpp:233
int SetLibItemName(const UTF8 &aLibItemName, bool aTestForRev=true)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:204
int SetLibNickname(const UTF8 &aNickname)
Override the logical library name portion of the LIB_ID to aNickname.
Definition: lib_id.cpp:193
const UTF8 & GetRevision() const
Definition: lib_id.h:129
LIB_ID()
Definition: lib_id.h:54
int Parse(const UTF8 &aId, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:122
static int HasIllegalChars(const UTF8 &aLibItemName)
Examine aLibItemName for invalid LIB_ID item name characters.
Definition: lib_id.cpp:331
wxString wx_str() const
Definition: utf8.cpp:51
bool operator<(const LIB_ID &aLibId) const
Definition: lib_id.h:203
UTF8 m_itemName
The name of the entry in the logical library.
Definition: lib_id.h:268
wxString GetUniStringLibId() const
Definition: lib_id.h:142
bool IsLegacy() const
Definition: lib_id.h:176
const wxString GetUniStringLibItemName() const
Get strings for display messages in dialogs.
Definition: lib_id.h:116
bool operator==(const LIB_ID &aLibId) const
Definition: lib_id.h:205
bool empty() const
Definition: utf8.h:103
static unsigned FindIllegalLibraryNameChar(const UTF8 &aLibraryName)
Looks for characters that are illegal in library nicknames.
Definition: lib_id.cpp:398