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 <[email protected]>
5 * Copyright (C) 2012 Wayne Stambaugh <[email protected]>
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
48class LIB_ID
49{
50public:
51 LIB_ID() {}
52
53 // NOTE: don't define any constructors which call Parse() on their arguments. We want it
54 // to be obvious to callers that parsing is involved (and that valid IDs are guaranteed in
55 // the presence of disallowed characters, malformed ids, etc.).
56
66 LIB_ID( const wxString& aLibraryName, const wxString& aItemName );
67
82 int Parse( const UTF8& aId, bool aFix = false );
83
87 const UTF8& GetLibNickname() const { return m_libraryName; }
88
96 int SetLibNickname( const UTF8& aNickname );
97
101 const UTF8& GetLibItemName() const { return m_itemName; }
102
111 const wxString GetUniStringLibItemName() const { return m_itemName.wx_str(); }
112
120 int SetLibItemName( const UTF8& aLibItemName );
121
130 void SetSubLibraryName( const UTF8& aName ) { m_subLibraryName = aName; }
131
135 UTF8 Format() const;
136
141 wxString GetUniStringLibId() const
142 {
143 return Format().wx_str();
144 }
145
152 static UTF8 Format( const UTF8& aLibraryName, const UTF8& aLibItemName );
153
165 bool IsValid() const
166 {
167 return !m_libraryName.empty() && !m_itemName.empty();
168 }
169
173 bool IsLegacy() const
174 {
175 return m_libraryName.empty() && !m_itemName.empty();
176 }
177
181 void clear();
182
186 bool empty() const
187 {
188 return m_libraryName.empty() && m_itemName.empty();
189 }
190
198 int compare( const LIB_ID& aLibId ) const;
199
200 bool operator < ( const LIB_ID& aLibId ) const { return this->compare( aLibId ) < 0; }
201 bool operator > ( const LIB_ID& aLibId ) const { return this->compare( aLibId ) > 0; }
202 bool operator ==( const LIB_ID& aLibId ) const { return this->compare( aLibId ) == 0; }
203 bool operator !=( const LIB_ID& aLibId ) const { return !(*this == aLibId); }
204
211 static int HasIllegalChars( const UTF8& aLibItemName );
212
220 static UTF8 FixIllegalChars( const UTF8& aLibItemName, bool aLib );
221
228 static unsigned FindIllegalLibraryNameChar( const UTF8& aLibraryName );
229
230protected:
254 static bool isLegalChar( unsigned aUniChar );
255
262 static bool isLegalLibraryNameChar( unsigned aUniChar );
263
267};
268
269
270#endif // _LIB_ID_H_
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
int Parse(const UTF8 &aId, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:50
bool operator==(const LIB_ID &aLibId) const
Definition: lib_id.h:202
int SetLibItemName(const UTF8 &aLibItemName)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:109
bool operator!=(const LIB_ID &aLibId) const
Definition: lib_id.h:203
LIB_ID()
Definition: lib_id.h:51
bool IsValid() const
Check if this LID_ID is valid.
Definition: lib_id.h:165
static int HasIllegalChars(const UTF8 &aLibItemName)
Examine aLibItemName for invalid LIB_ID item name characters.
Definition: lib_id.cpp:174
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:159
bool empty() const
Definition: lib_id.h:186
static bool isLegalChar(unsigned aUniChar)
Tests whether a Unicode character is a legal LIB_ID item name character.
Definition: lib_id.cpp:207
bool operator<(const LIB_ID &aLibId) const
Definition: lib_id.h:200
wxString GetUniStringLibId() const
Definition: lib_id.h:141
static unsigned FindIllegalLibraryNameChar(const UTF8 &aLibraryName)
Looks for characters that are illegal in library nicknames.
Definition: lib_id.cpp:242
UTF8 Format() const
Definition: lib_id.cpp:117
UTF8 m_libraryName
The nickname of the library or empty.
Definition: lib_id.h:264
void SetSubLibraryName(const UTF8 &aName)
Definition: lib_id.h:130
const wxString GetUniStringLibItemName() const
Get strings for display messages in dialogs.
Definition: lib_id.h:111
int SetLibNickname(const UTF8 &aNickname)
Override the logical library name portion of the LIB_ID to aNickname.
Definition: lib_id.cpp:98
const UTF8 & GetLibItemName() const
Definition: lib_id.h:101
bool operator>(const LIB_ID &aLibId) const
Definition: lib_id.h:201
bool IsLegacy() const
Definition: lib_id.h:173
UTF8 GetSubLibraryName() const
Some LIB_IDs can have a sub-library identifier in addition to a library nickname.
Definition: lib_id.h:129
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:87
static UTF8 FixIllegalChars(const UTF8 &aLibItemName, bool aLib)
Replace illegal LIB_ID item name characters with underscores '_'.
Definition: lib_id.cpp:190
UTF8 m_itemName
The name of the entry in the logical library.
Definition: lib_id.h:265
void clear()
Clear the contents of the library nickname, library entry name.
Definition: lib_id.cpp:42
UTF8 m_subLibraryName
Optional sub-library name used for grouping within a library.
Definition: lib_id.h:266
static bool isLegalLibraryNameChar(unsigned aUniChar)
Tests whether a Unicode character is a legal LIB_ID library nickname character.
Definition: lib_id.cpp:254
An 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to and fro...
Definition: utf8.h:71
bool empty() const
Definition: utf8.h:103
wxString wx_str() const
Definition: utf8.cpp:46