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 indention 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...
 
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 (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 PROPERTIESParseOptions (const std::string &aOptionsList)
 Parses aOptionsList and places the result into a PROPERTIES object which is returned. More...
 
static UTF8 FormatOptions (const PROPERTIES *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) const
 Return a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBack table fragment, else NULL. More...
 
LIB_TABLE_ROWfindRow (const wxString &aNickname)
 
void reindex ()
 
void ensureIndex ()
 

Protected Attributes

LIB_TABLE_ROWS rows
 
INDEX nickIndex
 this particular key is the nickName within each row. More...
 
LIB_TABLEfallBack
 

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 277 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 525 of file lib_table_base.h.

◆ INDEX_CITER

typedef INDEX::const_iterator LIB_TABLE::INDEX_CITER
protected

Definition at line 527 of file lib_table_base.h.

◆ INDEX_ITER

typedef INDEX::iterator LIB_TABLE::INDEX_ITER
protected

Definition at line 526 of file lib_table_base.h.

◆ INDEX_VALUE

typedef INDEX::value_type LIB_TABLE::INDEX_VALUE
protected

Definition at line 528 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 128 of file lib_table_base.cpp.

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

◆ ~LIB_TABLE()

LIB_TABLE::~LIB_TABLE ( )
virtual

Definition at line 136 of file lib_table_base.cpp.

137 {
138  // *fallBack is not owned here.
139 }

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 366 of file lib_table_base.h.

367  {
368  return rows[aIndex];
369  }
LIB_TABLE_ROWS rows

References rows.

Referenced by SYMBOL_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), and SCH::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 374 of file lib_table_base.h.

375  {
376  return rows[aIndex];
377  }
LIB_TABLE_ROWS rows

References rows.

◆ Clear()

void LIB_TABLE::Clear ( )
inline

Delete all rows.

Definition at line 323 of file lib_table_base.h.

324  {
325  rows.clear();
326  nickIndex.clear();
327  }
LIB_TABLE_ROWS rows
INDEX nickIndex
this particular key is the nickName within each row.

References nickIndex, and rows.

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

◆ ensureIndex()

void LIB_TABLE::ensureIndex ( )
inlineprotected

Definition at line 513 of file lib_table_base.h.

514  {
515  // The dialog lib table editor may not maintain the nickIndex.
516  // Lazy indexing may be required. To handle lazy indexing, we must enforce
517  // that "nickIndex" is either empty or accurate, but never inaccurate.
518  if( !nickIndex.size() )
519  reindex();
520  }
void reindex()
INDEX nickIndex
this particular key is the nickName within each row.

References nickIndex, and reindex().

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

◆ findRow() [1/2]

LIB_TABLE_ROW * LIB_TABLE::findRow ( const wxString &  aNickname) const
protected

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

Definition at line 190 of file lib_table_base.cpp.

191 {
192  LIB_TABLE* cur = (LIB_TABLE*) this;
193 
194  do
195  {
196  cur->ensureIndex();
197 
198  INDEX_CITER it = cur->nickIndex.find( aNickName );
199 
200  if( it != cur->nickIndex.end() )
201  {
202  return &cur->rows[it->second]; // found
203  }
204 
205  // not found, search fall back table(s), if any
206  } while( ( cur = cur->fallBack ) != 0 );
207 
208  return nullptr; // not found
209 }
void ensureIndex()
INDEX::const_iterator INDEX_CITER
LIB_TABLE_ROWS rows
LIB_TABLE * fallBack
INDEX nickIndex
this particular key is the nickName within each row.
Manage LIB_TABLE_ROW records (rows), and can be searched based on library nickname.

References ensureIndex(), fallBack, nickIndex, and rows.

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

◆ findRow() [2/2]

LIB_TABLE_ROW * LIB_TABLE::findRow ( const wxString &  aNickname)
protected

Definition at line 212 of file lib_table_base.cpp.

213 {
214  LIB_TABLE* cur = (LIB_TABLE*) this;
215 
216  do
217  {
218  cur->ensureIndex();
219 
220  INDEX_ITER it = cur->nickIndex.find( aNickName );
221 
222  if( it != cur->nickIndex.end() )
223  {
224  return &cur->rows[it->second]; // found
225  }
226 
227  // not found, search fall back table(s), if any
228  } while( ( cur = cur->fallBack ) != 0 );
229 
230  return nullptr; // not found
231 }
void ensureIndex()
LIB_TABLE_ROWS rows
LIB_TABLE * fallBack
INDEX::iterator INDEX_ITER
INDEX nickIndex
this particular key is the nickName within each row.
Manage LIB_TABLE_ROW records (rows), and can be searched based on library nickname.

References ensureIndex(), fallBack, nickIndex, and rows.

◆ 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 234 of file lib_table_base.cpp.

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

References ensureIndex(), fallBack, and rows.

Referenced by FOOTPRINT_EDIT_FRAME::KiwayMailIn(), and LIB_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 indention 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 PROPERTIES 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 415 of file lib_table_base.cpp.

416 {
417  UTF8 ret;
418 
419  if( aProperties )
420  {
421  for( PROPERTIES::const_iterator it = aProperties->begin(); it != aProperties->end(); ++it )
422  {
423  const std::string& name = it->first;
424 
425  const UTF8& value = it->second;
426 
427  if( ret.size() )
428  ret += OPT_SEP;
429 
430  ret += name;
431 
432  // the separation between name and value is '='
433  if( value.size() )
434  {
435  ret += '=';
436 
437  for( std::string::const_iterator si = value.begin(); si != value.end(); ++si )
438  {
439  // escape any separator in the value.
440  if( *si == OPT_SEP )
441  ret += '\\';
442 
443  ret += *si;
444  }
445  }
446  }
447  }
448 
449  return ret;
450 }
UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to...
Definition: utf8.h:73
const char * name
Definition: DXF_plotter.cpp:59
std::string::const_iterator end() const
Definition: utf8.h:197
std::string::const_iterator begin() const
Definition: utf8.h:196
std::string::size_type size() const
Definition: utf8.h:115
#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

Get the number of rows contained in the table.

Definition at line 356 of file lib_table_base.h.

357  {
358  return rows.size();
359  }
LIB_TABLE_ROWS rows

References rows.

Referenced by BOOST_AUTO_TEST_CASE(), FP_TREE_SYNCHRONIZING_ADAPTER::GetLibrariesCount(), SYMBOL_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), and SCH::IFACE::SaveFileAs().

◆ 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 151 of file lib_table_base.cpp.

152 {
153  // use "no exception" form of find row:
154  const LIB_TABLE_ROW* row = findRow( aNickname );
155 
156  if( row )
157  return row->GetDescr();
158  else
159  return wxEmptyString;
160 }
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
const wxString & GetDescr() const
Return the description of the library referenced by this row.
LIB_TABLE_ROW * findRow(const wxString &aNickname) 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::AddLibrary(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), LIB_EDIT_FRAME::savePartAs(), 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 177 of file lib_table_base.cpp.

178 {
179  const LIB_TABLE_ROW* row = findRow( aNickname );
180 
181  wxString retv;
182 
183  if( row )
184  retv = row->GetFullURI( aExpandEnvVars );
185 
186  return retv;
187 }
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
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...
LIB_TABLE_ROW * findRow(const wxString &aNickname) 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::GetFullURI().

Referenced by CVPCB_MAINFRAME::DisplayStatus(), SCH_EDIT_FRAME::LoadSheetFromFile(), NETLIST_EXPORTER_GENERIC::makeLibraries(), and FOOTPRINT_EDIT_FRAME::Process_Special_Functions().

◆ 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 270 of file lib_table_base.cpp.

271 {
272  // Only return unique logical library names. Use std::set::insert() to
273  // quietly reject any duplicates, which can happen when encountering a duplicate
274  // nickname from one of the fall back table(s).
275 
276  std::set< wxString > unique;
277  std::vector< wxString > ret;
278  const LIB_TABLE* cur = this;
279 
280  do
281  {
282  for( LIB_TABLE_ROWS_CITER it = cur->rows.begin(); it!=cur->rows.end(); ++it )
283  {
284  if( it->GetIsEnabled() )
285  {
286  unique.insert( it->GetNickName() );
287  }
288  }
289 
290  } while( ( cur = cur->fallBack ) != 0 );
291 
292  ret.reserve( unique.size() );
293 
294  // return a sorted, unique set of nicknames in a std::vector<wxString> to caller
295  for( std::set< wxString >::const_iterator it = unique.begin(); it!=unique.end(); ++it )
296  {
297  ret.push_back( *it );
298  }
299 
300  // We want to allow case-sensitive duplicates but sort by case-insensitive ordering
301  std::sort( ret.begin(), ret.end(), []( const wxString& lhs, const wxString& rhs )
302  {
303  return lhs.CmpNoCase( rhs ) < 0;
304  } );
305 
306  return ret;
307 }
LIB_TABLE_ROWS rows
LIB_TABLE * fallBack
LIB_TABLE_ROWS::const_iterator LIB_TABLE_ROWS_CITER
Manage LIB_TABLE_ROW records (rows), and can be searched based on library nickname.

References fallBack, and rows.

Referenced by FP_TREE_MODEL_ADAPTER::AddLibraries(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), FP_LIB_TABLE::GenerateTimestamp(), GetFootprintLibraries(), SYMBOL_LIB_TABLE::GetModifyHash(), guessNickname(), CVPCB_MAINFRAME::LoadFootprintFiles(), SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname(), FOOTPRINT_VIEWER_FRAME::OnActivate(), LIB_VIEW_FRAME::OnSelectSymbol(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), LIB_EDIT_FRAME::savePartAs(), SCH_BASE_FRAME::SelectCompFromLibTree(), PCB_BASE_FRAME::SelectLibrary(), FOOTPRINT_LIST_IMPL::StartWorkers(), and FP_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ HasLibrary()

bool LIB_TABLE::HasLibrary ( const wxString &  aNickname,
bool  aCheckEnabled = false 
) const

Test for the existence of aNickname 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 163 of file lib_table_base.cpp.

164 {
165  const LIB_TABLE_ROW* row = findRow( aNickname );
166 
167  if( row == nullptr )
168  return false;
169 
170  if( aCheckEnabled && !row->GetIsEnabled() )
171  return false;
172 
173  return true;
174 }
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
bool GetIsEnabled() const
LIB_TABLE_ROW * findRow(const wxString &aNickname) 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::GetIsEnabled().

Referenced by CVPCB_MAINFRAME::DisplayStatus(), InvokeSchEditSymbolLibTable(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), LIB_EDIT_FRAME::KiwayMailIn(), LIB_MANAGER::LibraryExists(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_EDIT_FRAME::LoadSheetFromFile(), NETLIST_EXPORTER_GENERIC::makeLibraries(), SCH_BASE_FRAME::SelectCompFromLibTree(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), and SCH_SCREEN::UpdateSymbolLinks().

◆ 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 310 of file lib_table_base.cpp.

311 {
312  ensureIndex();
313 
314  INDEX_CITER it = nickIndex.find( aRow->GetNickName() );
315 
316  if( it == nickIndex.end() )
317  {
318  rows.push_back( aRow );
319  nickIndex.insert( INDEX_VALUE( aRow->GetNickName(), rows.size() - 1 ) );
320  return true;
321  }
322 
323  if( doReplace )
324  {
325  rows.replace( it->second, aRow );
326  return true;
327  }
328 
329  return false;
330 }
void ensureIndex()
INDEX::const_iterator INDEX_CITER
LIB_TABLE_ROWS rows
INDEX::value_type INDEX_VALUE
const wxString & GetNickName() const
INDEX nickIndex
this particular key is the nickName within each row.

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), PCB_EDIT_FRAME::importFile(), LIB_TABLE_TEST_FIXTURE::LIB_TABLE_TEST_FIXTURE(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), FP_LIB_TABLE::Parse(), and SYMBOL_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 142 of file lib_table_base.cpp.

143 {
144  if( !aIncludeFallback || !fallBack )
145  return rows.empty();
146 
147  return rows.empty() && fallBack->IsEmpty( true );
148 }
LIB_TABLE_ROWS rows
LIB_TABLE * fallBack
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(), PCB_EDIT_FRAME::LoadFootprints(), 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 333 of file lib_table_base.cpp.

335 {
336  // It's OK if footprint library tables are missing.
337  if( wxFileName::IsFileReadable( aFileName ) )
338  {
339  FILE_LINE_READER reader( aFileName );
340  LIB_TABLE_LEXER lexer( &reader );
341 
342  Parse( &lexer );
343  }
344 }
FILE_LINE_READER is a LINE_READER that reads from an open file.
Definition: richio.h:181
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 SYMBOL_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), SCH_EDIT_FRAME::LoadSheetFromFile(), PROJECT::PcbFootprintLibs(), SCH::IFACE::SaveFileAs(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow(), and DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow().

◆ operator!=()

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

Definition at line 351 of file lib_table_base.h.

351 { return !( *this == 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 335 of file lib_table_base.h.

336  {
337  if( rows.size() == r.rows.size() )
338  {
339  unsigned i;
340 
341  for( i = 0; i < rows.size() && rows[i] == r.rows[i]; ++i )
342  ;
343 
344  if( i == rows.size() )
345  return true;
346  }
347 
348  return false;
349  }
LIB_TABLE_ROWS rows

References 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()

PROPERTIES * 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 354 of file lib_table_base.cpp.

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

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 505 of file lib_table_base.h.

506  {
507  nickIndex.clear();
508 
509  for( LIB_TABLE_ROWS_ITER it = rows.begin(); it != rows.end(); ++it )
510  nickIndex.insert( INDEX_VALUE( it->GetNickName(), it - rows.begin() ) );
511  }
LIB_TABLE_ROWS rows
INDEX::value_type INDEX_VALUE
LIB_TABLE_ROWS::iterator LIB_TABLE_ROWS_ITER
INDEX nickIndex
this particular key is the nickName within each row.

References nickIndex, and rows.

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

◆ RemoveRow()

bool LIB_TABLE::RemoveRow ( 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 433 of file lib_table_base.h.

434  {
435  for( auto iter = rows.begin(); iter != rows.end(); ++iter )
436  {
437  if( *iter == *aRow )
438  {
439  rows.erase( iter, iter + 1 );
440  return true;
441  }
442  }
443  return false;
444  }
LIB_TABLE_ROWS rows

References rows.

Referenced by LIB_MANAGER::addLibrary().

◆ 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 347 of file lib_table_base.cpp.

348 {
349  FILE_OUTPUTFORMATTER sf( aFileName );
350  Format( &sf, 0 );
351 }
virtual void Format(OUTPUTFORMATTER *aOutput, int aIndentLevel) const =0
Generate the table in s-expression format to aOutput with an indention level of aIndentLevel.
FILE_OUTPUTFORMATTER may be used for text file output.
Definition: richio.h:493

References Format().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), PCB_EDIT_FRAME::importFile(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), SYMBOL_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), SCH::IFACE::SaveFileAs(), SCH_BASE_FRAME::saveSymbolLibTables(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow(), and DIALOG_GLOBAL_SYM_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 280 of file lib_table_base.h.

◆ PANEL_FP_LIB_TABLE

friend class PANEL_FP_LIB_TABLE
friend

Definition at line 279 of file lib_table_base.h.

Member Data Documentation

◆ fallBack

LIB_TABLE* LIB_TABLE::fallBack
protected

Definition at line 533 of file lib_table_base.h.

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

◆ nickIndex

INDEX LIB_TABLE::nickIndex
protected

this particular key is the nickName within each row.

Definition at line 531 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: