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...
 
static const wxString ExpandSubstitutions (const wxString &aString)
 Replaces any environment variable references with their values and is here to fully embellish the TABLE_ROW::uri in a platform independent way. 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 262 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 519 of file lib_table_base.h.

◆ INDEX_CITER

typedef INDEX::const_iterator LIB_TABLE::INDEX_CITER
protected

Definition at line 521 of file lib_table_base.h.

◆ INDEX_ITER

typedef INDEX::iterator LIB_TABLE::INDEX_ITER
protected

Definition at line 520 of file lib_table_base.h.

◆ INDEX_VALUE

typedef INDEX::value_type LIB_TABLE::INDEX_VALUE
protected

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

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

◆ ~LIB_TABLE()

LIB_TABLE::~LIB_TABLE ( )
virtual

Definition at line 137 of file lib_table_base.cpp.

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

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

352  {
353  return rows[aIndex];
354  }
LIB_TABLE_ROWS rows

References rows.

Referenced by SYMBOL_GRID_TRICKS::paste_text(), and FP_GRID_TRICKS::paste_text().

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

360  {
361  return rows[aIndex];
362  }
LIB_TABLE_ROWS rows

References rows.

◆ Clear()

void LIB_TABLE::Clear ( )
inline

Delete all rows.

Definition at line 308 of file lib_table_base.h.

309  {
310  rows.clear();
311  nickIndex.clear();
312  }
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 507 of file lib_table_base.h.

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

References nickIndex, and reindex().

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

◆ ExpandSubstitutions()

const wxString LIB_TABLE::ExpandSubstitutions ( const wxString &  aString)
static

Replaces any environment variable references with their values and is here to fully embellish the TABLE_ROW::uri in a platform independent way.

This enables library tables to have platform dependent environment variables in them, allowing for a uniform table across platforms.

Definition at line 454 of file lib_table_base.cpp.

455 {
456  return ExpandEnvVarSubstitutions( aString );
457 }
const wxString ExpandEnvVarSubstitutions(const wxString &aString)
Replace any environment variable references with their values.
Definition: common.cpp:525

References ExpandEnvVarSubstitutions().

Referenced by GITHUB_PLUGIN::cacheLib(), LIB_TABLE_ROW::GetFullURI(), and LIB_TABLE_ROW::SetFullURI().

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

192 {
193  LIB_TABLE* cur = (LIB_TABLE*) this;
194 
195  do
196  {
197  cur->ensureIndex();
198 
199  INDEX_CITER it = cur->nickIndex.find( aNickName );
200 
201  if( it != cur->nickIndex.end() )
202  {
203  return &cur->rows[it->second]; // found
204  }
205 
206  // not found, search fall back table(s), if any
207  } while( ( cur = cur->fallBack ) != 0 );
208 
209  return nullptr; // not found
210 }
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 213 of file lib_table_base.cpp.

214 {
215  LIB_TABLE* cur = (LIB_TABLE*) this;
216 
217  do
218  {
219  cur->ensureIndex();
220 
221  INDEX_ITER it = cur->nickIndex.find( aNickName );
222 
223  if( it != cur->nickIndex.end() )
224  {
225  return &cur->rows[it->second]; // found
226  }
227 
228  // not found, search fall back table(s), if any
229  } while( ( cur = cur->fallBack ) != 0 );
230 
231  return nullptr; // not found
232 }
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 235 of file lib_table_base.cpp.

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

417 {
418  UTF8 ret;
419 
420  if( aProperties )
421  {
422  for( PROPERTIES::const_iterator it = aProperties->begin(); it != aProperties->end(); ++it )
423  {
424  const std::string& name = it->first;
425 
426  const UTF8& value = it->second;
427 
428  if( ret.size() )
429  ret += OPT_SEP;
430 
431  ret += name;
432 
433  // the separation between name and value is '='
434  if( value.size() )
435  {
436  ret += '=';
437 
438  for( std::string::const_iterator si = value.begin(); si != value.end(); ++si )
439  {
440  // escape any separator in the value.
441  if( *si == OPT_SEP )
442  ret += '\\';
443 
444  ret += *si;
445  }
446  }
447  }
448  }
449 
450  return ret;
451 }
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:60
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 341 of file lib_table_base.h.

342  {
343  return rows.size();
344  }
LIB_TABLE_ROWS rows

References rows.

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

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

153 {
154  // use "no exception" form of find row:
155  const LIB_TABLE_ROW* row = findRow( aNickname );
156 
157  if( row )
158  return row->GetDescr();
159  else
160  return wxEmptyString;
161 }
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 178 of file lib_table_base.cpp.

179 {
180  const LIB_TABLE_ROW* row = findRow( aNickname );
181 
182  wxString retv;
183 
184  if( row )
185  retv = row->GetFullURI( aExpandEnvVars );
186 
187  return retv;
188 }
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 271 of file lib_table_base.cpp.

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

165 {
166  const LIB_TABLE_ROW* row = findRow( aNickname );
167 
168  if( row == nullptr )
169  return false;
170 
171  if( aCheckEnabled && !row->GetIsEnabled() )
172  return false;
173 
174  return true;
175 }
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(), SCH_EAGLE_PLUGIN::Load(), SCH_EDIT_FRAME::LoadSheetFromFile(), NETLIST_EXPORTER_GENERIC::makeLibraries(), SCH_COMPONENT::Resolve(), SCH_BASE_FRAME::SelectCompFromLibTree(), SCH_COMPONENT::SetLibId(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), and FP_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ 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  INDEX_CITER it = nickIndex.find( aRow->GetNickName() );
316 
317  if( it == nickIndex.end() )
318  {
319  rows.push_back( aRow );
320  nickIndex.insert( INDEX_VALUE( aRow->GetNickName(), rows.size() - 1 ) );
321  return true;
322  }
323 
324  if( doReplace )
325  {
326  rows.replace( it->second, aRow );
327  return true;
328  }
329 
330  return false;
331 }
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(), 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 143 of file lib_table_base.cpp.

144 {
145  if( !aIncludeFallback || !fallBack )
146  return rows.empty();
147 
148  return rows.empty() && fallBack->IsEmpty( true );
149 }
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 334 of file lib_table_base.cpp.

336 {
337  // It's OK if footprint library tables are missing.
338  if( wxFileName::IsFileReadable( aFileName ) )
339  {
340  FILE_LINE_READER reader( aFileName );
341  LIB_TABLE_LEXER lexer( &reader );
342 
343  Parse( &lexer );
344  }
345 }
FILE_LINE_READER is a LINE_READER that reads from an open file.
Definition: richio.h:180
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(), 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 336 of file lib_table_base.h.

336 { 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 320 of file lib_table_base.h.

321  {
322  if( rows.size() == r.rows.size() )
323  {
324  unsigned i;
325 
326  for( i = 0; i < rows.size() && rows[i] == r.rows[i]; ++i )
327  ;
328 
329  if( i == rows.size() )
330  return true;
331  }
332 
333  return false;
334  }
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 355 of file lib_table_base.cpp.

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

500  {
501  nickIndex.clear();
502 
503  for( LIB_TABLE_ROWS_ITER it = rows.begin(); it != rows.end(); ++it )
504  nickIndex.insert( INDEX_VALUE( it->GetNickName(), it - rows.begin() ) );
505  }
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 418 of file lib_table_base.h.

419  {
420  for( auto iter = rows.begin(); iter != rows.end(); ++iter )
421  {
422  if( *iter == *aRow )
423  {
424  rows.erase( iter, iter + 1 );
425  return true;
426  }
427  }
428  return false;
429  }
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 348 of file lib_table_base.cpp.

349 {
350  FILE_OUTPUTFORMATTER sf( aFileName );
351  Format( &sf, 0 );
352 }
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:492

References Format().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), PCB_EDIT_FRAME::importFile(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), SYMBOL_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), 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 265 of file lib_table_base.h.

◆ PANEL_FP_LIB_TABLE

friend class PANEL_FP_LIB_TABLE
friend

Definition at line 264 of file lib_table_base.h.

Member Data Documentation

◆ fallBack

LIB_TABLE* LIB_TABLE::fallBack
protected

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