KiCad PCB EDA Suite
LIB_TABLE Class Referenceabstract

Manage LIB_TABLE_ROW records (rows), and can be searched based on library nickname. More...

#include <lib_table_base.h>

Inheritance diagram for LIB_TABLE:
PROJECT::_ELEM FP_LIB_TABLE SYMBOL_LIB_TABLE TEST_LIB_TABLE FP_LIB_TABLE_GRID SYMBOL_LIB_TABLE_GRID

Public Member Functions

virtual void Parse (LIB_TABLE_LEXER *aLexer)=0
 Parse the #LIB_TABLE_LEXER s-expression library table format into the appropriate LIB_TABLE_ROW objects. More...
 
virtual void Format (OUTPUTFORMATTER *aOutput, int aIndentLevel) const =0
 Generate the table in s-expression format to aOutput with an indentation level of aIndentLevel. More...
 
 LIB_TABLE (LIB_TABLE *aFallBackTable=nullptr)
 Build a library table by pre-pending this table fragment in front of aFallBackTable. More...
 
virtual ~LIB_TABLE ()
 
void Clear ()
 Delete all rows. More...
 
bool operator== (const LIB_TABLE &r) const
 Compares this table against another. More...
 
bool operator!= (const LIB_TABLE &r) const
 
unsigned GetCount () const
 Get the number of rows contained in the table. More...
 
LIB_TABLE_ROWAt (unsigned aIndex)
 Get the 'n'th LIB_TABLE_ROW object. More...
 
const LIB_TABLE_ROWAt (unsigned aIndex) const
 Get the 'n'th LIB_TABLE_ROW object. More...
 
bool IsEmpty (bool aIncludeFallback=true)
 Return true if the table is empty. More...
 
const wxString GetDescription (const wxString &aNickname)
 
bool HasLibrary (const wxString &aNickname, bool aCheckEnabled=false) const
 Test for the existence of aNickname in the library table. More...
 
bool HasLibraryWithPath (const wxString &aPath) const
 Test for the existence of aPath in the library table. More...
 
std::vector< wxString > GetLogicalLibs ()
 Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE. More...
 
wxString GetFullURI (const wxString &aLibNickname, bool aExpandEnvVars=true) const
 Return the full URI of the library mapped to aLibNickname. More...
 
bool InsertRow (LIB_TABLE_ROW *aRow, bool doReplace=false)
 Adds aRow if it does not already exist or if doReplace is true. More...
 
bool RemoveRow (const LIB_TABLE_ROW *aRow)
 Removes a row from the table. More...
 
const LIB_TABLE_ROWFindRowByURI (const wxString &aURI)
 
void Load (const wxString &aFileName)
 Load the library table using the path defined by aFileName aFallBackTable. More...
 
void Save (const wxString &aFileName) const
 Write this library table to aFileName in s-expression form. More...
 
virtual KICAD_T Type ()=0
 

Static Public Member Functions

static STRING_UTF8_MAPParseOptions (const std::string &aOptionsList)
 Parses aOptionsList and places the result into a #PROPERTIES object which is returned. More...
 
static UTF8 FormatOptions (const STRING_UTF8_MAP *aProperties)
 Returns a list of options from the aProperties parameter. More...
 

Protected Types

typedef std::map< wxString, int > INDEX
 this is a non-owning index into the LIB_TABLE_ROWS table More...
 
typedef INDEX::iterator INDEX_ITER
 
typedef INDEX::const_iterator INDEX_CITER
 
typedef INDEX::value_type INDEX_VALUE
 

Protected Member Functions

LIB_TABLE_ROWfindRow (const wxString &aNickname, bool aCheckIfEnabled=false) const
 Return a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBack table fragment, else NULL. More...
 
void reindex ()
 
void ensureIndex ()
 

Protected Attributes

LIB_TABLE_ROWS rows
 
INDEX nickIndex
 this particular key is the nickName within each row. More...
 
LIB_TABLEfallBack
 
std::mutex m_nickIndexMutex
 Mutex to protect access to the nickIndex variable. More...
 

Friends

class PANEL_FP_LIB_TABLE
 
class LIB_TABLE_GRID
 

Detailed Description

Manage LIB_TABLE_ROW records (rows), and can be searched based on library nickname.

This class owns the library table, which is like fstab in concept and maps logical library name to the library URI, type, and options. It is heavily based on the SWEET parser work done by Dick Hollenbeck and can be seen in new/sch_lib_table.h. A library table has the following columns:

  • Logical Library Name (Nickname)
  • Library Type, used to determine which plugin to load to access the library.
  • Library URI. The full URI to the library source, form dependent on Type.
  • Options, used for as yet to be defined information such as user names or passwords

The Library Type can be one of:

  • "file"
  • "ftp"
  • "http"

For now, the Library URI types needed to support the various types can be one of those shown below, which are typical of each type:

  • "file://C:/mylibdir"
  • "ftp://kicad.org/partlib/trunk"
  • "http://kicad.org/partlib"

The library table is built up from several additive entries (table fragments), and the final table is a (conceptual) merging of the table fragments. Two anticipated sources of the entries are a personal table saved in the KiCad configuration and a project resident table that resides in project file. The project footprint table entries are considered a higher priority in the final dynamically assembled library table. An row in the project file contribution to the library table takes precedence over the personal table if there is a collision of logical library names. Otherwise, the entries simply combine without issue to make up the applicable library table.

Author
Wayne Stambaugh

Definition at line 299 of file lib_table_base.h.

Member Typedef Documentation

◆ INDEX

typedef std::map<wxString,int> LIB_TABLE::INDEX
protected

this is a non-owning index into the LIB_TABLE_ROWS table

Definition at line 561 of file lib_table_base.h.

◆ INDEX_CITER

typedef INDEX::const_iterator LIB_TABLE::INDEX_CITER
protected

Definition at line 563 of file lib_table_base.h.

◆ INDEX_ITER

typedef INDEX::iterator LIB_TABLE::INDEX_ITER
protected

Definition at line 562 of file lib_table_base.h.

◆ INDEX_VALUE

typedef INDEX::value_type LIB_TABLE::INDEX_VALUE
protected

Definition at line 564 of file lib_table_base.h.

Constructor & Destructor Documentation

◆ LIB_TABLE()

LIB_TABLE::LIB_TABLE ( LIB_TABLE aFallBackTable = nullptr)

Build a library table by pre-pending this table fragment in front of aFallBackTable.

Loading of this table fragment is done by using Parse().

Parameters
aFallBackTableis another LIB_TABLE which is searched only when a row is not found in this table. No ownership is taken of aFallBackTable.

Definition at line 125 of file lib_table_base.cpp.

125 :
126 fallBack( aFallBackTable )
127{
128 // not copying fall back, simply search aFallBackTable separately
129 // if "nickName not found".
130}
LIB_TABLE * fallBack

◆ ~LIB_TABLE()

LIB_TABLE::~LIB_TABLE ( )
virtual

Definition at line 133 of file lib_table_base.cpp.

134{
135 // *fallBack is not owned here.
136}

Member Function Documentation

◆ At() [1/2]

LIB_TABLE_ROW & LIB_TABLE::At ( unsigned  aIndex)
inline

Get the 'n'th LIB_TABLE_ROW object.

Parameters
aIndexindex of row (must exist: from 0 to GetCount() - 1)
Returns
reference to the row

Definition at line 386 of file lib_table_base.h.

387 {
388 return rows[aIndex];
389 }
LIB_TABLE_ROWS rows

References rows.

Referenced by FP_LIB_TABLE::LoadGlobalTable(), SYMBOL_LIB_TABLE::LoadGlobalTable(), SYMBOL_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), and PCB::IFACE::SaveFileAs().

◆ At() [2/2]

const LIB_TABLE_ROW & LIB_TABLE::At ( unsigned  aIndex) const
inline

Get the 'n'th LIB_TABLE_ROW object.

Parameters
aIndexindex of row (must exist: from 0 to GetCount() - 1)
Returns
reference to the row

Definition at line 394 of file lib_table_base.h.

395 {
396 return rows[aIndex];
397 }

References rows.

◆ Clear()

void LIB_TABLE::Clear ( )
inline

Delete all rows.

Definition at line 341 of file lib_table_base.h.

342 {
343 std::lock_guard<std::mutex> lock( m_nickIndexMutex );
344
345 rows.clear();
346 nickIndex.clear();
347 }
std::mutex m_nickIndexMutex
Mutex to protect access to the nickIndex variable.
INDEX nickIndex
this particular key is the nickName within each row.

References m_nickIndexMutex, nickIndex, and rows.

Referenced by PANEL_SYM_LIB_TABLE::TransferDataFromWindow(), and PANEL_FP_LIB_TABLE::TransferDataFromWindow().

◆ ensureIndex()

void LIB_TABLE::ensureIndex ( )
inlineprotected

Definition at line 544 of file lib_table_base.h.

545 {
546 // The dialog lib table editor may not maintain the nickIndex.
547 // Lazy indexing may be required. To handle lazy indexing, we must enforce
548 // that "nickIndex" is either empty or accurate, but never inaccurate.
549 if( !nickIndex.size() )
550 reindex();
551 }
void reindex()

References nickIndex, and reindex().

Referenced by findRow(), FindRowByURI(), and InsertRow().

◆ findRow()

LIB_TABLE_ROW * LIB_TABLE::findRow ( const wxString &  aNickname,
bool  aCheckIfEnabled = false 
) const
protected

Return a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBack table fragment, else NULL.

Parameters
aNicknameis the name of the library table entry to find.
aCheckIfEnabledis a flag to check if the library table entry is enabled.
Returns
a pointer to the LIB_TABLE_ROW found.

Definition at line 196 of file lib_table_base.cpp.

197{
198 LIB_TABLE_ROW* row = nullptr;
199 LIB_TABLE* cur = (LIB_TABLE*) this;
200
201 do
202 {
203 cur->ensureIndex();
204
205 for( const std::pair<const wxString, int>& entry : cur->nickIndex )
206 {
207 if( entry.first == aNickName )
208 {
209 row = &cur->rows[entry.second];
210
211 if( !aCheckIfEnabled || row->GetIsEnabled() )
212 return row;
213 }
214 }
215
216 // Repeat, this time looking for names that were "fixed" by legacy versions because
217 // the old eeschema file format didn't support spaces in tokens.
218 for( const std::pair<const wxString, int>& entry : cur->nickIndex )
219 {
220 wxString legacyLibName = entry.first;
221 legacyLibName.Replace( " ", "_" );
222
223 if( legacyLibName == aNickName )
224 {
225 row = &cur->rows[entry.second];
226
227 if( !aCheckIfEnabled || row->GetIsEnabled() )
228 return row;
229 }
230 }
231
232 // not found, search fall back table(s), if any
233 } while( ( cur = cur->fallBack ) != nullptr );
234
235 return nullptr; // not found
236}
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
bool GetIsEnabled() const
Manage LIB_TABLE_ROW records (rows), and can be searched based on library nickname.
void ensureIndex()

References ensureIndex(), fallBack, LIB_TABLE_ROW::GetIsEnabled(), nickIndex, and rows.

Referenced by SYMBOL_LIB_TABLE::FindRow(), FP_LIB_TABLE::FindRow(), GetDescription(), GetFullURI(), and HasLibrary().

◆ FindRowByURI()

const LIB_TABLE_ROW * LIB_TABLE::FindRowByURI ( const wxString &  aURI)
Returns
a LIB_TABLE_ROW pointer if aURI is found in this table or in any chained fallBack table fragments, else NULL.

Definition at line 239 of file lib_table_base.cpp.

240{
241 LIB_TABLE* cur = this;
242
243 do
244 {
245 cur->ensureIndex();
246
247 for( unsigned i = 0; i < cur->rows.size(); i++ )
248 {
249 wxString tmp = cur->rows[i].GetFullURI( true );
250
251 if( tmp.Find( "://" ) != wxNOT_FOUND )
252 {
253 if( tmp == aURI )
254 return &cur->rows[i]; // found as URI
255 }
256 else
257 {
258 wxFileName fn = aURI;
259
260 // This will also test if the file is a symlink so if we are comparing
261 // a symlink to the same real file, the comparison will be true. See
262 // wxFileName::SameAs() in the wxWidgets source.
263 if( fn == wxFileName( tmp ) )
264 return &cur->rows[i]; // found as full path and file name
265 }
266 }
267
268 // not found, search fall back table(s), if any
269 } while( ( cur = cur->fallBack ) != nullptr );
270
271 return nullptr; // not found
272}

References ensureIndex(), fallBack, and rows.

Referenced by PCB_EDIT_FRAME::ExportFootprintsToLibrary(), SYMBOL_EDIT_FRAME::KiwayMailIn(), and FOOTPRINT_EDIT_FRAME::KiwayMailIn().

◆ Format()

virtual void LIB_TABLE::Format ( OUTPUTFORMATTER aOutput,
int  aIndentLevel 
) const
pure virtual

Generate the table in s-expression format to aOutput with an indentation level of aIndentLevel.

Parameters
aOutputis the OUTPUTFORMATTER to format the table into.
aIndentLevelis the indentation level (2 spaces) to indent.
Exceptions
IO_ERRORif an I/O error occurs during output.
boost::interprocess::lock_exceptif separate process attempt to access the table.

Implemented in SYMBOL_LIB_TABLE, FP_LIB_TABLE, and TEST_LIB_TABLE.

Referenced by Save().

◆ FormatOptions()

UTF8 LIB_TABLE::FormatOptions ( const STRING_UTF8_MAP aProperties)
static

Returns a list of options from the aProperties parameter.

The name=value pairs will be separated with the '|' character. The =value portion may not be present. You might expect something like "name1=value1|name2=value2|flag_me". Notice that flag_me does not have a value. This is ok.

Parameters
aPropertiesis the PROPERTIES to format or NULL. If NULL the returned string will be empty.

Definition at line 423 of file lib_table_base.cpp.

424{
425 UTF8 ret;
426
427 if( aProperties )
428 {
429 for( STRING_UTF8_MAP::const_iterator it = aProperties->begin(); it != aProperties->end(); ++it )
430 {
431 const std::string& name = it->first;
432
433 const UTF8& value = it->second;
434
435 if( ret.size() )
436 ret += OPT_SEP;
437
438 ret += name;
439
440 // the separation between name and value is '='
441 if( value.size() )
442 {
443 ret += '=';
444
445 for( std::string::const_iterator si = value.begin(); si != value.end(); ++si )
446 {
447 // escape any separator in the value.
448 if( *si == OPT_SEP )
449 ret += '\\';
450
451 ret += *si;
452 }
453 }
454 }
455 }
456
457 return ret;
458}
const char * name
Definition: DXF_plotter.cpp:56
An 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to and fro...
Definition: utf8.h:71
std::string::const_iterator begin() const
Definition: utf8.h:192
std::string::size_type size() const
Definition: utf8.h:110
std::string::const_iterator end() const
Definition: utf8.h:193
#define OPT_SEP
options separator character

References UTF8::begin(), UTF8::end(), name, OPT_SEP, and UTF8::size().

Referenced by DIALOG_FP_PLUGIN_OPTIONS::TransferDataFromWindow().

◆ GetCount()

unsigned LIB_TABLE::GetCount ( ) const
inline

◆ GetDescription()

const wxString LIB_TABLE::GetDescription ( const wxString &  aNickname)
Returns
the library description from aNickname, or an empty string if aNickname does not exist.

Definition at line 148 of file lib_table_base.cpp.

149{
150 // Use "no exception" form of find row and ignore disabled flag.
151 const LIB_TABLE_ROW* row = findRow( aNickname );
152
153 if( row )
154 return row->GetDescr();
155 else
156 return wxEmptyString;
157}
const wxString & GetDescr() const
Return the description of the library referenced by this row.
LIB_TABLE_ROW * findRow(const wxString &aNickname, bool aCheckIfEnabled=false) const
Return a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBack table fragment,...

References findRow(), and LIB_TABLE_ROW::GetDescr().

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), and PCB_BASE_FRAME::SelectLibrary().

◆ GetFullURI()

wxString LIB_TABLE::GetFullURI ( const wxString &  aLibNickname,
bool  aExpandEnvVars = true 
) const

Return the full URI of the library mapped to aLibNickname.

Definition at line 183 of file lib_table_base.cpp.

184{
185 const LIB_TABLE_ROW* row = findRow( aNickname, true );
186
187 wxString retv;
188
189 if( row )
190 retv = row->GetFullURI( aExpandEnvVars );
191
192 return retv;
193}
const wxString GetFullURI(bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...

References findRow(), and LIB_TABLE_ROW::GetFullURI().

Referenced by CVPCB_MAINFRAME::DisplayStatus(), SCH_EDIT_FRAME::LoadSheetFromFile(), NETLIST_EXPORTER_XML::makeLibraries(), and FOOTPRINT_EDITOR_CONTROL::SaveAs().

◆ GetLogicalLibs()

std::vector< wxString > LIB_TABLE::GetLogicalLibs ( )

Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.

Definition at line 275 of file lib_table_base.cpp.

276{
277 // Only return unique logical library names. Use std::set::insert() to quietly reject any
278 // duplicates (usually due to encountering a duplicate nickname in a fallback table).
279
280 std::set<wxString> unique;
281 std::vector<wxString> ret;
282 const LIB_TABLE* cur = this;
283
284 do
285 {
286 for( LIB_TABLE_ROWS_CITER it = cur->rows.begin(); it!=cur->rows.end(); ++it )
287 {
288 if( it->GetIsEnabled() )
289 unique.insert( it->GetNickName() );
290 }
291
292 } while( ( cur = cur->fallBack ) != nullptr );
293
294 ret.reserve( unique.size() );
295
296 // return a sorted, unique set of nicknames in a std::vector<wxString> to caller
297 for( std::set< wxString >::const_iterator it = unique.begin(); it!=unique.end(); ++it )
298 ret.push_back( *it );
299
300 // We want to allow case-sensitive duplicates but sort by case-insensitive ordering
301 std::sort( ret.begin(), ret.end(),
302 []( const wxString& lhs, const wxString& rhs )
303 {
304 return StrNumCmp( lhs, rhs, true /* ignore case */ ) < 0;
305 } );
306
307 return ret;
308}
LIB_TABLE_ROWS::const_iterator LIB_TABLE_ROWS_CITER

References fallBack, and rows.

Referenced by FP_TREE_MODEL_ADAPTER::AddLibraries(), CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), FP_LIB_TABLE::GenerateTimestamp(), GetFootprintLibraries(), SYMBOL_LIBRARY_MANAGER::GetLibraryCount(), SYMBOL_LIB_TABLE::GetModifyHash(), guessNickname(), CVPCB_MAINFRAME::LoadFootprintFiles(), SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname(), FOOTPRINT_VIEWER_FRAME::OnActivate(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_BASE_FRAME::PickSymbolFromLibTree(), FOOTPRINT_LIST_IMPL::ReadFootprintFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), PCB_BASE_FRAME::SelectLibrary(), and FP_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ HasLibrary()

◆ HasLibraryWithPath()

bool LIB_TABLE::HasLibraryWithPath ( const wxString &  aPath) const

Test for the existence of aPath in the library table.

Parameters
aCheckEnabledif true will only return true for enabled libraries
Returns
true if a library aNickname exists in the table.

Definition at line 171 of file lib_table_base.cpp.

172{
173 for( const LIB_TABLE_ROW& row : rows )
174 {
175 if( row.GetFullURI() == aPath )
176 return true;
177 }
178
179 return false;
180}

References rows.

Referenced by PCM_FP_LIB_TRAVERSER::OnDir(), and PCM_SYM_LIB_TRAVERSER::OnFile().

◆ InsertRow()

bool LIB_TABLE::InsertRow ( LIB_TABLE_ROW aRow,
bool  doReplace = false 
)

Adds aRow if it does not already exist or if doReplace is true.

If doReplace is not true and the key for aRow already exists, the function fails and returns false.

The key for the table is the nickName, and all in this table must be unique.

Parameters
aRowis the new row to insert, or to forcibly add if doReplace is true.
doReplaceif true, means insert regardless of whether aRow's key already exists. If false, then fail if the key already exists.
Returns
bool - true if the operation succeeded.

Definition at line 311 of file lib_table_base.cpp.

312{
313 ensureIndex();
314
315 std::lock_guard<std::mutex> lock( m_nickIndexMutex );
316
317 INDEX_CITER it = nickIndex.find( aRow->GetNickName() );
318
319 aRow->SetParent( this );
320
321 if( it == nickIndex.end() )
322 {
323 rows.push_back( aRow );
324 nickIndex.insert( INDEX_VALUE( aRow->GetNickName(), rows.size() - 1 ) );
325 return true;
326 }
327
328 if( doReplace )
329 {
330 rows.replace( it->second, aRow );
331 return true;
332 }
333
334 return false;
335}
void SetParent(LIB_TABLE *aParent)
const wxString & GetNickName() const
INDEX::value_type INDEX_VALUE
INDEX::const_iterator INDEX_CITER

References ensureIndex(), LIB_TABLE_ROW::GetNickName(), m_nickIndexMutex, nickIndex, rows, and LIB_TABLE_ROW::SetParent().

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), LIB_TABLE_TEST_FIXTURE::LIB_TABLE_TEST_FIXTURE(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), PCM_FP_LIB_TRAVERSER::OnDir(), PCM_SYM_LIB_TRAVERSER::OnFile(), PCB_EDIT_FRAME::OpenProjectFiles(), SYMBOL_LIB_TABLE::Parse(), and FP_LIB_TABLE::Parse().

◆ IsEmpty()

bool LIB_TABLE::IsEmpty ( bool  aIncludeFallback = true)

Return true if the table is empty.

Parameters
aIncludeFallbackis used to determine if the fallback table should be included in the test.
Returns
true if the footprint library table is empty.

Definition at line 139 of file lib_table_base.cpp.

140{
141 if( !aIncludeFallback || !fallBack )
142 return rows.empty();
143
144 return rows.empty() && fallBack->IsEmpty( true );
145}
bool IsEmpty(bool aIncludeFallback=true)
Return true if the table is empty.

References fallBack, IsEmpty(), and rows.

Referenced by BOOST_AUTO_TEST_CASE(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), IsEmpty(), and SCH_EDIT_FRAME::LoadSheetFromFile().

◆ Load()

void LIB_TABLE::Load ( const wxString &  aFileName)

Load the library table using the path defined by aFileName aFallBackTable.

Parameters
aFileNamecontains the full path to the s-expression file.
Exceptions
IO_ERRORif an error occurs attempting to load the footprint library table.

Definition at line 338 of file lib_table_base.cpp.

339{
340 // It's OK if footprint library tables are missing.
341 if( wxFileName::IsFileReadable( aFileName ) )
342 {
343 FILE_LINE_READER reader( aFileName );
344 LIB_TABLE_LEXER lexer( &reader );
345
346 Parse( &lexer );
347 }
348}
A LINE_READER that reads from an open file.
Definition: richio.h:173
virtual void Parse(LIB_TABLE_LEXER *aLexer)=0
Parse the #LIB_TABLE_LEXER s-expression library table format into the appropriate LIB_TABLE_ROW objec...

References Parse().

Referenced by FP_LIB_TABLE::LoadGlobalTable(), SYMBOL_LIB_TABLE::LoadGlobalTable(), SCH_EDIT_FRAME::LoadSheetFromFile(), PROJECT::PcbFootprintLibs(), PCB::IFACE::SaveFileAs(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow(), and DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow().

◆ operator!=()

bool LIB_TABLE::operator!= ( const LIB_TABLE r) const
inline

Definition at line 371 of file lib_table_base.h.

371{ return !( *this == r ); }
E_SERIE r
Definition: eserie.cpp:41

References r.

◆ operator==()

bool LIB_TABLE::operator== ( const LIB_TABLE r) const
inline

Compares this table against another.

This compares the row contents against each other. Any fallback tables are not checked.

Definition at line 355 of file lib_table_base.h.

356 {
357 if( rows.size() == r.rows.size() )
358 {
359 unsigned i;
360
361 for( i = 0; i < rows.size() && rows[i] == r.rows[i]; ++i )
362 ;
363
364 if( i == rows.size() )
365 return true;
366 }
367
368 return false;
369 }

References r, and rows.

◆ Parse()

virtual void LIB_TABLE::Parse ( LIB_TABLE_LEXER *  aLexer)
pure virtual

Parse the #LIB_TABLE_LEXER s-expression library table format into the appropriate LIB_TABLE_ROW objects.

Parameters
aLexeris the lexer to parse.
Exceptions
IO_ERRORif an I/O error occurs during parsing.
PARSER_ERRORif the lexer format to parse is invalid.
boost::bad_pointerif an any attempt to add an invalid pointer to the boost::ptr_vector.
boost::bad_indexif an index outside the row table bounds is accessed.

Implemented in SYMBOL_LIB_TABLE, FP_LIB_TABLE, and TEST_LIB_TABLE.

Referenced by Load().

◆ ParseOptions()

STRING_UTF8_MAP * LIB_TABLE::ParseOptions ( const std::string &  aOptionsList)
static

Parses aOptionsList and places the result into a #PROPERTIES object which is returned.

If the options field is empty, then the returned PROPERTIES will be a NULL pointer.

Typically aOptionsList comes from the "options" field within a LIB_TABLE_ROW and the format is simply a comma separated list of name value pairs. e.g.: [name1[=value1][|name2[=value2]]] etc. When using the UI to create or edit a library table, this formatting is handled for you.

Definition at line 358 of file lib_table_base.cpp.

359{
360 if( aOptionsList.size() )
361 {
362 const char* cp = &aOptionsList[0];
363 const char* end = cp + aOptionsList.size();
364
365 STRING_UTF8_MAP props;
366 std::string pair;
367
368 // Parse all name=value pairs
369 while( cp < end )
370 {
371 pair.clear();
372
373 // Skip leading white space.
374 while( cp < end && isspace( *cp ) )
375 ++cp;
376
377 // Find the end of pair/field
378 while( cp < end )
379 {
380 if( *cp == '\\' && cp + 1 < end && cp[1] == OPT_SEP )
381 {
382 ++cp; // skip the escape
383 pair += *cp++; // add the separator
384 }
385 else if( *cp == OPT_SEP )
386 {
387 ++cp; // skip the separator
388 break; // process the pair
389 }
390 else
391 {
392 pair += *cp++;
393 }
394 }
395
396 // stash the pair
397 if( pair.size() )
398 {
399 // first equals sign separates 'name' and 'value'.
400 size_t eqNdx = pair.find( '=' );
401
402 if( eqNdx != pair.npos )
403 {
404 std::string name = pair.substr( 0, eqNdx );
405 std::string value = pair.substr( eqNdx + 1 );
406 props[name] = value;
407 }
408 else
409 {
410 props[pair] = ""; // property is present, but with no value.
411 }
412 }
413 }
414
415 if( props.size() )
416 return new STRING_UTF8_MAP( props );
417 }
418
419 return nullptr;
420}
A name/value tuple with unique names and optional values.

References name, and OPT_SEP.

Referenced by LIB_TABLE_ROW::SetOptions(), and DIALOG_FP_PLUGIN_OPTIONS::TransferDataToWindow().

◆ reindex()

void LIB_TABLE::reindex ( )
inlineprotected

Definition at line 534 of file lib_table_base.h.

535 {
536 std::lock_guard<std::mutex> lock( m_nickIndexMutex );
537
538 nickIndex.clear();
539
540 for( LIB_TABLE_ROWS_ITER it = rows.begin(); it != rows.end(); ++it )
541 nickIndex.insert( INDEX_VALUE( it->GetNickName(), it - rows.begin() ) );
542 }
LIB_TABLE_ROWS::iterator LIB_TABLE_ROWS_ITER

References m_nickIndexMutex, nickIndex, and rows.

Referenced by ensureIndex(), PANEL_SYM_LIB_TABLE::TransferDataFromWindow(), and PANEL_FP_LIB_TABLE::TransferDataFromWindow().

◆ RemoveRow()

bool LIB_TABLE::RemoveRow ( const LIB_TABLE_ROW aRow)
inline

Removes a row from the table.

Parameters
aRowis the row to remove
Returns
true if the row was found (and removed)

Definition at line 461 of file lib_table_base.h.

462 {
463 for( auto iter = rows.begin(); iter != rows.end(); ++iter )
464 {
465 if( *iter == *aRow )
466 {
467 rows.erase( iter, iter + 1 );
468 return true;
469 }
470 }
471 return false;
472 }

References rows.

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary(), FP_LIB_TABLE::LoadGlobalTable(), and SYMBOL_LIB_TABLE::LoadGlobalTable().

◆ Save()

void LIB_TABLE::Save ( const wxString &  aFileName) const

Write this library table to aFileName in s-expression form.

Parameters
aFileNameis the name of the file to write to.

Definition at line 351 of file lib_table_base.cpp.

352{
353 FILE_OUTPUTFORMATTER sf( aFileName );
354 Format( &sf, 0 );
355}
Used for text file output.
Definition: richio.h:457
virtual void Format(OUTPUTFORMATTER *aOutput, int aIndentLevel) const =0
Generate the table in s-expression format to aOutput with an indentation level of aIndentLevel.

References Format().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), FP_LIB_TABLE::LoadGlobalTable(), SYMBOL_LIB_TABLE::LoadGlobalTable(), PCB_EDIT_FRAME::OpenProjectFiles(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), PCB::IFACE::SaveFileAs(), SCH_BASE_FRAME::saveSymbolLibTables(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow(), and DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow().

◆ Type()

virtual KICAD_T PROJECT::_ELEM::Type ( )
pure virtualinherited

Friends And Related Function Documentation

◆ LIB_TABLE_GRID

friend class LIB_TABLE_GRID
friend

Definition at line 555 of file lib_table_base.h.

◆ PANEL_FP_LIB_TABLE

friend class PANEL_FP_LIB_TABLE
friend

Definition at line 554 of file lib_table_base.h.

Member Data Documentation

◆ fallBack

LIB_TABLE* LIB_TABLE::fallBack
protected

Definition at line 569 of file lib_table_base.h.

Referenced by findRow(), FindRowByURI(), GetLogicalLibs(), and IsEmpty().

◆ m_nickIndexMutex

std::mutex LIB_TABLE::m_nickIndexMutex
mutableprotected

Mutex to protect access to the nickIndex variable.

Definition at line 572 of file lib_table_base.h.

Referenced by Clear(), InsertRow(), and reindex().

◆ nickIndex

INDEX LIB_TABLE::nickIndex
protected

this particular key is the nickName within each row.

Definition at line 567 of file lib_table_base.h.

Referenced by Clear(), ensureIndex(), findRow(), InsertRow(), and reindex().

◆ rows


The documentation for this class was generated from the following files: