KiCad PCB EDA Suite
LIB_TABLE Class Referenceabstract

Class LIB_TABLE. More...

#include <lib_table_base.h>

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

Public Member Functions

virtual void Parse (LIB_TABLE_LEXER *aLexer)=0
 Function Parse. 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=NULL)
 Constructor LIB_TABLE builds 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
 
bool operator!= (const LIB_TABLE &r) const
 
int GetCount ()
 
LIB_TABLE_ROWAt (int aIndex)
 
bool IsEmpty (bool aIncludeFallback=true)
 Function IsEmpty. More...
 
const wxString GetDescription (const wxString &aNickname)
 Function GetDescription. More...
 
std::vector< wxString > GetLogicalLibs ()
 Function GetLogicalLibs. More...
 
bool InsertRow (LIB_TABLE_ROW *aRow, bool doReplace=false)
 Function InsertRow. More...
 
const LIB_TABLE_ROWFindRowByURI (const wxString &aURI)
 Function FindRowByURI. More...
 
void Load (const wxString &aFileName)
 Function Load. More...
 
void Save (const wxString &aFileName) const
 Function Save. More...
 
size_t GetEnvVars (wxArrayString &aEnvVars) const
 Search the paths all of the LIB_TABLE_ROWS of the LIB_TABLE and add all of the environment variable substitutions to aEnvVars. More...
 

Static Public Member Functions

static PROPERTIESParseOptions (const std::string &aOptionsList)
 Function ParseOptions. More...
 
static UTF8 FormatOptions (const PROPERTIES *aProperties)
 Function FormatOptions. More...
 
static const wxString ExpandSubstitutions (const wxString &aString)
 Function ExpandSubstitutions. 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
 Function findRow returns 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
 

Friends

class DIALOG_FP_LIB_TABLE
 
class LIB_TABLE_GRID
 

Detailed Description

Class LIB_TABLE.

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

Member Typedef Documentation

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

this is a non-owning index into the LIB_TABLE_ROWS table

Definition at line 506 of file lib_table_base.h.

typedef INDEX::const_iterator LIB_TABLE::INDEX_CITER
protected

Definition at line 508 of file lib_table_base.h.

typedef INDEX::iterator LIB_TABLE::INDEX_ITER
protected

Definition at line 507 of file lib_table_base.h.

typedef INDEX::value_type LIB_TABLE::INDEX_VALUE
protected

Definition at line 509 of file lib_table_base.h.

Constructor & Destructor Documentation

LIB_TABLE::LIB_TABLE ( LIB_TABLE aFallBackTable = NULL)

Constructor LIB_TABLE builds 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 219 of file lib_table_base.cpp.

219  :
220  fallBack( aFallBackTable )
221 {
222  // not copying fall back, simply search aFallBackTable separately
223  // if "nickName not found".
224 }
LIB_TABLE * fallBack
LIB_TABLE::~LIB_TABLE ( )
virtual

Definition at line 227 of file lib_table_base.cpp.

228 {
229  // *fallBack is not owned here.
230 }

Member Function Documentation

LIB_TABLE_ROW* LIB_TABLE::At ( int  aIndex)
inline

Definition at line 354 of file lib_table_base.h.

References rows.

Referenced by FP_GRID_TRICKS::paste_text().

354 { return &rows[aIndex]; }
LIB_TABLE_ROWS rows
void LIB_TABLE::Clear ( )
inline

Delete all rows.

Definition at line 328 of file lib_table_base.h.

References nickIndex, and rows.

Referenced by DIALOG_FP_LIB_TABLE::onOKButtonClick().

329  {
330  rows.clear();
331  nickIndex.clear();
332  }
LIB_TABLE_ROWS rows
INDEX nickIndex
this particular key is the nickName within each row.
void LIB_TABLE::ensureIndex ( )
inlineprotected

Definition at line 494 of file lib_table_base.h.

References nickIndex, and reindex().

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

495  {
496  // The dialog lib table editor may not maintain the nickIndex.
497  // Lazy indexing may be required. To handle lazy indexing, we must enforce
498  // that "nickIndex" is either empty or accurate, but never inaccurate.
499  if( !nickIndex.size() )
500  reindex();
501  }
void reindex()
INDEX nickIndex
this particular key is the nickName within each row.
const wxString LIB_TABLE::ExpandSubstitutions ( const wxString &  aString)
static

Function ExpandSubstitutions.

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

References ExpandEnvVarSubstitutions().

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

513 {
514  return ExpandEnvVarSubstitutions( aString );
515 }
const wxString ExpandEnvVarSubstitutions(const wxString &aString)
Function ExpandEnvVarSubstitutions replaces any environment variable references with their values...
Definition: common.cpp:254
LIB_TABLE_ROW * LIB_TABLE::findRow ( const wxString &  aNickname) const
protected

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

Definition at line 254 of file lib_table_base.cpp.

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

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

255 {
256  LIB_TABLE* cur = (LIB_TABLE*) this;
257 
258  do
259  {
260  cur->ensureIndex();
261 
262  INDEX_CITER it = cur->nickIndex.find( aNickName );
263 
264  if( it != cur->nickIndex.end() )
265  {
266  return &cur->rows[it->second]; // found
267  }
268 
269  // not found, search fall back table(s), if any
270  } while( ( cur = cur->fallBack ) != 0 );
271 
272  return NULL; // not found
273 }
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.
Class LIB_TABLE.
const LIB_TABLE_ROW * LIB_TABLE::FindRowByURI ( const wxString &  aURI)

Function FindRowByURI.

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

References ensureIndex(), fallBack, and rows.

277 {
278  LIB_TABLE* cur = this;
279 
280  do
281  {
282  cur->ensureIndex();
283 
284  for( unsigned i = 0; i < cur->rows.size(); i++ )
285  {
286  wxString uri = cur->rows[i].GetFullURI( true );
287 
288  if( wxFileName::GetPathSeparator() == wxChar( '\\' ) && uri.Find( wxChar( '/' ) ) >= 0 )
289  uri.Replace( "/", "\\" );
290 
291  if( (wxFileName::IsCaseSensitive() && uri == aURI)
292  || (!wxFileName::IsCaseSensitive() && uri.Upper() == aURI.Upper() ) )
293  {
294  return &cur->rows[i]; // found
295  }
296  }
297 
298  // not found, search fall back table(s), if any
299  } while( ( cur = cur->fallBack ) != 0 );
300 
301  return NULL; // not found
302 }
void ensureIndex()
LIB_TABLE_ROWS rows
LIB_TABLE * fallBack
Class LIB_TABLE.
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 FP_LIB_TABLE, and SYMBOL_LIB_TABLE.

Referenced by Save().

UTF8 LIB_TABLE::FormatOptions ( const PROPERTIES aProperties)
static

Function FormatOptions.

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

References name, and OPT_SEP.

Referenced by DIALOG_FP_PLUGIN_OPTIONS::makeResult().

475 {
476  UTF8 ret;
477 
478  if( aProperties )
479  {
480  for( PROPERTIES::const_iterator it = aProperties->begin(); it != aProperties->end(); ++it )
481  {
482  const std::string& name = it->first;
483 
484  const UTF8& value = it->second;
485 
486  if( ret.size() )
487  ret += OPT_SEP;
488 
489  ret += name;
490 
491  // the separation between name and value is '='
492  if( value.size() )
493  {
494  ret += '=';
495 
496  for( std::string::const_iterator si = value.begin(); si != value.end(); ++si )
497  {
498  // escape any separator in the value.
499  if( *si == OPT_SEP )
500  ret += '\\';
501 
502  ret += *si;
503  }
504  }
505  }
506  }
507 
508  return ret;
509 }
Class UTF8 is an 8 bit std::string that is assuredly encoded in UTF8, and supplies special conversion...
Definition: utf8.h:53
const char * name
#define OPT_SEP
options separator character
int LIB_TABLE::GetCount ( )
inline

Definition at line 352 of file lib_table_base.h.

References rows.

Referenced by FP_GRID_TRICKS::paste_text().

352 { return rows.size(); }
LIB_TABLE_ROWS rows
const wxString LIB_TABLE::GetDescription ( const wxString &  aNickname)

Function GetDescription.

Returns
the library description from aNickname, or an empty string if aNickname does not exist.

Definition at line 242 of file lib_table_base.cpp.

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

Referenced by PCB_BASE_FRAME::SelectLibrary().

243 {
244  // use "no exception" form of find row:
245  const LIB_TABLE_ROW* row = findRow( aNickname );
246 
247  if( row )
248  return row->GetDescr();
249  else
250  return wxEmptyString;
251 }
Class LIB_TABLE_ROW.
LIB_TABLE_ROW * findRow(const wxString &aNickname) const
Function findRow returns a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBa...
const wxString & GetDescr() const
Function GetDescr.
size_t LIB_TABLE::GetEnvVars ( wxArrayString &  aEnvVars) const

Search the paths all of the LIB_TABLE_ROWS of the LIB_TABLE and add all of the environment variable substitutions to aEnvVars.

This will only add unique environment variables to the list. Duplicates are ignored.

Parameters
aEnvVarsis the array to load the environment variables.
Returns
the number of unique environment variables found in the table.

Definition at line 380 of file lib_table_base.cpp.

References fallBack, and rows.

381 {
382  const LIB_TABLE* cur = this;
383 
384  do
385  {
386  for( unsigned i = 0; i < cur->rows.size(); i++ )
387  {
388  wxString uri = cur->rows[i].GetFullURI( false );
389 
390  int start = uri.Find( "${" );
391 
392  if( start == wxNOT_FOUND )
393  continue;
394 
395  int end = uri.Find( '}' );
396 
397  if( end == wxNOT_FOUND || end < start+2 )
398  continue;
399 
400  wxString envVar = uri.Mid( start+2, end - (start+2) );
401 
402  if( aEnvVars.Index( envVar, false ) == wxNOT_FOUND )
403  aEnvVars.Add( envVar );
404  }
405 
406  // not found, search fall back table(s), if any
407  } while( ( cur = cur->fallBack ) != 0 );
408 
409  return aEnvVars.GetCount();
410 }
LIB_TABLE_ROWS rows
LIB_TABLE * fallBack
Class LIB_TABLE.
std::vector< wxString > LIB_TABLE::GetLogicalLibs ( )

Function GetLogicalLibs.

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

Definition at line 305 of file lib_table_base.cpp.

References fallBack, and rows.

Referenced by CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), guessNickname(), CVPCB_MAINFRAME::LoadFootprintFiles(), SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname(), FOOTPRINT_VIEWER_FRAME::OnActivate(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), PCB_BASE_FRAME::SelectLibrary(), and FOOTPRINT_LIST_IMPL::StartWorkers().

306 {
307  // Only return unique logical library names. Use std::set::insert() to
308  // quietly reject any duplicates, which can happen when encountering a duplicate
309  // nickname from one of the fall back table(s).
310 
311  std::set< wxString > unique;
312  std::vector< wxString > ret;
313  const LIB_TABLE* cur = this;
314 
315  do
316  {
317  for( LIB_TABLE_ROWS_CITER it = cur->rows.begin(); it!=cur->rows.end(); ++it )
318  {
319  unique.insert( it->GetNickName() );
320  }
321 
322  } while( ( cur = cur->fallBack ) != 0 );
323 
324  ret.reserve( unique.size() );
325 
326  // return a sorted, unique set of nicknames in a std::vector<wxString> to caller
327  for( std::set< wxString >::const_iterator it = unique.begin(); it!=unique.end(); ++it )
328  {
329  ret.push_back( *it );
330  }
331 
332  return ret;
333 }
LIB_TABLE_ROWS rows
LIB_TABLE * fallBack
LIB_TABLE_ROWS::const_iterator LIB_TABLE_ROWS_CITER
Class LIB_TABLE.
bool LIB_TABLE::InsertRow ( LIB_TABLE_ROW aRow,
bool  doReplace = false 
)

Function InsertRow.

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

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

Referenced by DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), InvokeFootprintWizard(), SYMBOL_LIB_TABLE::Parse(), and FP_LIB_TABLE::Parse().

337 {
338  ensureIndex();
339 
340  INDEX_CITER it = nickIndex.find( aRow->GetNickName() );
341 
342  if( it == nickIndex.end() )
343  {
344  rows.push_back( aRow );
345  nickIndex.insert( INDEX_VALUE( aRow->GetNickName(), rows.size() - 1 ) );
346  return true;
347  }
348 
349  if( doReplace )
350  {
351  rows.replace( it->second, aRow );
352  return true;
353  }
354 
355  return false;
356 }
void ensureIndex()
INDEX::const_iterator INDEX_CITER
LIB_TABLE_ROWS rows
INDEX::value_type INDEX_VALUE
const wxString & GetNickName() const
Function GetNickName.
INDEX nickIndex
this particular key is the nickName within each row.
bool LIB_TABLE::IsEmpty ( bool  aIncludeFallback = true)

Function IsEmpty.

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

References fallBack, IsEmpty(), and rows.

Referenced by IsEmpty(), PCB_EDIT_FRAME::LoadFootprints(), and FOOTPRINT_EDIT_FRAME::OnUpdateSelectCurrentLib().

234 {
235  if( !aIncludeFallback || !fallBack )
236  return rows.empty();
237 
238  return rows.empty() && fallBack->IsEmpty( true );
239 }
LIB_TABLE_ROWS rows
LIB_TABLE * fallBack
bool IsEmpty(bool aIncludeFallback=true)
Function IsEmpty.
void LIB_TABLE::Load ( const wxString &  aFileName)

Function Load.

loads 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 359 of file lib_table_base.cpp.

References Parse().

Referenced by SYMBOL_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), and PROJECT::PcbFootprintLibs().

361 {
362  // It's OK if footprint library tables are missing.
363  if( wxFileName::IsFileReadable( aFileName ) )
364  {
365  FILE_LINE_READER reader( aFileName );
366  LIB_TABLE_LEXER lexer( &reader );
367 
368  Parse( &lexer );
369  }
370 }
Class 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
Function Parse.
Class LIB_TABLE_LEXER is an automatically generated class using the TokenList2DnsLexer.cmake technology, based on keywords provided by file: /home/kicad/workspace/kicad-doxygen/common/lib_table.keywords.
bool LIB_TABLE::operator!= ( const LIB_TABLE r) const
inline

Definition at line 350 of file lib_table_base.h.

350 { return !( *this == r ); }
bool LIB_TABLE::operator== ( const LIB_TABLE r) const
inline

Definition at line 334 of file lib_table_base.h.

References rows.

335  {
336  if( rows.size() == r.rows.size() )
337  {
338  unsigned i;
339 
340  for( i = 0; i < rows.size() && rows[i] == r.rows[i]; ++i )
341  ;
342 
343  if( i == rows.size() )
344  return true;
345  }
346 
347  return false;
348  }
LIB_TABLE_ROWS rows
virtual void LIB_TABLE::Parse ( LIB_TABLE_LEXER aLexer)
pure virtual

Function Parse.

Parses 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 FP_LIB_TABLE, and SYMBOL_LIB_TABLE.

Referenced by Load().

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

Function ParseOptions.

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

References name, and OPT_SEP.

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

414 {
415  if( aOptionsList.size() )
416  {
417  const char* cp = &aOptionsList[0];
418  const char* end = cp + aOptionsList.size();
419 
420  PROPERTIES props;
421  std::string pair;
422 
423  // Parse all name=value pairs
424  while( cp < end )
425  {
426  pair.clear();
427 
428  // Skip leading white space.
429  while( cp < end && isspace( *cp ) )
430  ++cp;
431 
432  // Find the end of pair/field
433  while( cp < end )
434  {
435  if( *cp == '\\' && cp + 1 < end && cp[1] == OPT_SEP )
436  {
437  ++cp; // skip the escape
438  pair += *cp++; // add the separator
439  }
440  else if( *cp == OPT_SEP )
441  {
442  ++cp; // skip the separator
443  break; // process the pair
444  }
445  else
446  pair += *cp++;
447  }
448 
449  // stash the pair
450  if( pair.size() )
451  {
452  // first equals sign separates 'name' and 'value'.
453  size_t eqNdx = pair.find( '=' );
454 
455  if( eqNdx != pair.npos )
456  {
457  std::string name = pair.substr( 0, eqNdx );
458  std::string value = pair.substr( eqNdx + 1 );
459  props[name] = value;
460  }
461  else
462  props[pair] = ""; // property is present, but with no value.
463  }
464  }
465 
466  if( props.size() )
467  return new PROPERTIES( props );
468  }
469 
470  return NULL;
471 }
std::vector< PROPERTY > PROPERTIES
Definition: specctra.h:184
Class PROPERTIES is a name/value tuple with unique names and optional values.
Definition: properties.h:34
const char * name
#define OPT_SEP
options separator character
void LIB_TABLE::reindex ( )
inlineprotected

Definition at line 486 of file lib_table_base.h.

References nickIndex, and rows.

Referenced by ensureIndex(), and DIALOG_FP_LIB_TABLE::onOKButtonClick().

487  {
488  nickIndex.clear();
489 
490  for( LIB_TABLE_ROWS_ITER it = rows.begin(); it != rows.end(); ++it )
491  nickIndex.insert( INDEX_VALUE( it->GetNickName(), it - rows.begin() ) );
492  }
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.
void LIB_TABLE::Save ( const wxString &  aFileName) const

Function Save.

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

Parameters
aFileNameis the name of the file to write to.

Definition at line 373 of file lib_table_base.cpp.

References Format().

Referenced by SYMBOL_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), CVPCB_MAINFRAME::OnEditFootprintLibraryTable(), PCB_EDIT_FRAME::Process_Config(), and FOOTPRINT_EDIT_FRAME::ProcessPreferences().

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

Friends And Related Function Documentation

friend class DIALOG_FP_LIB_TABLE
friend

Definition at line 281 of file lib_table_base.h.

friend class LIB_TABLE_GRID
friend

Definition at line 282 of file lib_table_base.h.

Member Data Documentation

LIB_TABLE* LIB_TABLE::fallBack
protected

Definition at line 514 of file lib_table_base.h.

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

INDEX LIB_TABLE::nickIndex
protected

this particular key is the nickName within each row.

Definition at line 512 of file lib_table_base.h.

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


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