KiCad PCB EDA Suite
SYMBOL_LIB_TABLE Class Reference

#include <symbol_lib_table.h>

Inheritance diagram for SYMBOL_LIB_TABLE:
LIB_TABLE PROJECT::_ELEM SYMBOL_LIB_TABLE_GRID

Public Types

enum  SAVE_T { SAVE_OK, SAVE_SKIPPED }
 The set of return values from SaveSymbol() below. More...
 

Public Member Functions

KICAD_T Type () override
 
virtual void Parse (LIB_TABLE_LEXER *aLexer) override
 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 override
 Generate the table in s-expression format to aOutput with an indention level of aIndentLevel. More...
 
 SYMBOL_LIB_TABLE (SYMBOL_LIB_TABLE *aFallBackTable=NULL)
 Build a symbol library table by pre-pending this table fragment in front of aFallBackTable. More...
 
SYMBOL_LIB_TABLE_ROWFindRow (const wxString &aNickName)
 Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table fragment. More...
 
int GetModifyHash ()
 
void EnumerateSymbolLib (const wxString &aNickname, wxArrayString &aAliasNames, bool aPowerSymbolsOnly=false)
 Return a list of symbol alias names contained within the library given by aNickname. More...
 
void LoadSymbolLib (std::vector< LIB_PART * > &aAliasList, const wxString &aNickname, bool aPowerSymbolsOnly=false)
 
LIB_PARTLoadSymbol (const wxString &aNickname, const wxString &aName)
 Load a LIB_PART having aName from the library given by aNickname. More...
 
LIB_PARTLoadSymbol (const LIB_ID &aLibId)
 
SAVE_T SaveSymbol (const wxString &aNickname, const LIB_PART *aSymbol, bool aOverwrite=true)
 Write aSymbol to an existing library given by aNickname. More...
 
void DeleteSymbol (const wxString &aNickname, const wxString &aSymbolName)
 Deletes the aSymbolName from the library given by aNickname. More...
 
bool IsSymbolLibWritable (const wxString &aNickname)
 Return true if the library given by aNickname is writable. More...
 
void DeleteSymbolLib (const wxString &aNickname)
 
void CreateSymbolLib (const wxString &aNickname)
 
LIB_PARTLoadSymbolWithOptionalNickname (const LIB_ID &aId)
 Load a LIB_PART having aFootprintId with possibly an empty library nickname. More...
 
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...
 

Static Public Member Functions

static bool LoadGlobalTable (SYMBOL_LIB_TABLE &aTable)
 Load the global symbol library table into aTable. More...
 
static wxString GetGlobalTableFileName ()
 Fetch the global symbol library table file name. More...
 
static const wxString GlobalPathEnvVariableName ()
 Return the name of the environment variable used to hold the directory of locally installed "KiCad sponsored" system symbol libraries. More...
 
static SYMBOL_LIB_TABLEGetGlobalLibTable ()
 
static const wxString & GetSymbolLibTableFileName ()
 
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 Public Attributes

static const char * PropPowerSymsOnly = "pwr_sym_only"
 
static const char * PropNonPowerSymsOnly = "non_pwr_sym_only"
 

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
 

Static Private Attributes

static int m_modifyHash = 1
 helper for GetModifyHash() More...
 

Friends

class SYMBOL_LIB_TABLE_GRID
 
class PANEL_SYM_LIB_TABLE
 

Detailed Description

Definition at line 103 of file symbol_lib_table.h.

Member Typedef Documentation

◆ INDEX

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

this is a non-owning index into the LIB_TABLE_ROWS table

Definition at line 510 of file lib_table_base.h.

◆ INDEX_CITER

typedef INDEX::const_iterator LIB_TABLE::INDEX_CITER
protectedinherited

Definition at line 512 of file lib_table_base.h.

◆ INDEX_ITER

typedef INDEX::iterator LIB_TABLE::INDEX_ITER
protectedinherited

Definition at line 511 of file lib_table_base.h.

◆ INDEX_VALUE

typedef INDEX::value_type LIB_TABLE::INDEX_VALUE
protectedinherited

Definition at line 513 of file lib_table_base.h.

Member Enumeration Documentation

◆ SAVE_T

The set of return values from SaveSymbol() below.

Enumerator
SAVE_OK 
SAVE_SKIPPED 

Definition at line 186 of file symbol_lib_table.h.

Constructor & Destructor Documentation

◆ SYMBOL_LIB_TABLE()

SYMBOL_LIB_TABLE::SYMBOL_LIB_TABLE ( SYMBOL_LIB_TABLE aFallBackTable = NULL)

Build a symbol 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 SYMBOL_LIB_TABLE which is searched only when a row is not found in this table. No ownership is taken of aFallBackTable.

Definition at line 72 of file symbol_lib_table.cpp.

72  :
73  LIB_TABLE( aFallBackTable )
74 {
75  // not copying fall back, simply search aFallBackTable separately
76  // if "nickName not found".
77 }
LIB_TABLE(LIB_TABLE *aFallBackTable=nullptr)
Build a library table by pre-pending this table fragment in front of aFallBackTable.

Member Function Documentation

◆ At() [1/2]

LIB_TABLE_ROW& LIB_TABLE::At ( unsigned  aIndex)
inlineinherited

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 LIB_TABLE::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
inlineinherited

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 LIB_TABLE::rows.

◆ Clear()

void LIB_TABLE::Clear ( )
inlineinherited

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 LIB_TABLE::nickIndex, and LIB_TABLE::rows.

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

◆ CreateSymbolLib()

void SYMBOL_LIB_TABLE::CreateSymbolLib ( const wxString &  aNickname)

Definition at line 413 of file symbol_lib_table.cpp.

414 {
415  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
416  wxCHECK( row && row->plugin, /* void */ );
417  row->plugin->CreateSymbolLib( row->GetFullURI( true ), row->GetProperties() );
418 }
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
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...
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).

References FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetProperties(), and SYMBOL_LIB_TABLE_ROW::plugin.

Referenced by LIB_MANAGER::addLibrary().

◆ DeleteSymbol()

void SYMBOL_LIB_TABLE::DeleteSymbol ( const wxString &  aNickname,
const wxString &  aSymbolName 
)

Deletes the aSymbolName from the library given by aNickname.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW.
aSymbolNameis the name of a symbol to delete from the specified library.
Exceptions
IO_ERRORif there is a problem finding the footprint or the library, or deleting it.

Definition at line 388 of file symbol_lib_table.cpp.

389 {
390  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
391  wxCHECK( row && row->plugin, /* void */ );
392  return row->plugin->DeleteSymbol( row->GetFullURI( true ), aSymbolName,
393  row->GetProperties() );
394 }
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
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...
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).

References FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetProperties(), and SYMBOL_LIB_TABLE_ROW::plugin.

◆ DeleteSymbolLib()

void SYMBOL_LIB_TABLE::DeleteSymbolLib ( const wxString &  aNickname)

Definition at line 405 of file symbol_lib_table.cpp.

406 {
407  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
408  wxCHECK( row && row->plugin, /* void */ );
409  row->plugin->DeleteSymbolLib( row->GetFullURI( true ), row->GetProperties() );
410 }
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
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...
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).

References FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetProperties(), and SYMBOL_LIB_TABLE_ROW::plugin.

◆ ensureIndex()

void LIB_TABLE::ensureIndex ( )
inlineprotectedinherited

Definition at line 498 of file lib_table_base.h.

499  {
500  // The dialog lib table editor may not maintain the nickIndex.
501  // Lazy indexing may be required. To handle lazy indexing, we must enforce
502  // that "nickIndex" is either empty or accurate, but never inaccurate.
503  if( !nickIndex.size() )
504  reindex();
505  }
void reindex()
INDEX nickIndex
this particular key is the nickName within each row.

References LIB_TABLE::nickIndex, and LIB_TABLE::reindex().

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

◆ EnumerateSymbolLib()

void SYMBOL_LIB_TABLE::EnumerateSymbolLib ( const wxString &  aNickname,
wxArrayString &  aAliasNames,
bool  aPowerSymbolsOnly = false 
)

Return a list of symbol alias names contained within the library given by aNickname.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW.
aAliasNamesis a reference to an array for the alias names.
aPowerSymbolsOnlyis a flag to enumerate only power symbols.
Exceptions
IO_ERRORif the library cannot be found or loaded.

Definition at line 265 of file symbol_lib_table.cpp.

267 {
268  SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
269  wxCHECK( row && row->plugin, /* void */ );
270 
271  wxString options = row->GetOptions();
272 
273  if( aPowerSymbolsOnly )
274  row->SetOptions( row->GetOptions() + " " + PropPowerSymsOnly );
275 
276  row->plugin->EnumerateSymbolLib( aAliasNames, row->GetFullURI( true ), row->GetProperties() );
277 
278  if( aPowerSymbolsOnly )
279  row->SetOptions( options );
280 }
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
const wxString & GetOptions() const
Return the options string, which may hold a password or anything else needed to instantiate the under...
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
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...
void SetOptions(const wxString &aOptions)
Change the library options strings.
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).
static const char * PropPowerSymsOnly

References FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetOptions(), LIB_TABLE_ROW::GetProperties(), SYMBOL_LIB_TABLE_ROW::plugin, PropPowerSymsOnly, and LIB_TABLE_ROW::SetOptions().

Referenced by LIB_MANAGER::getOriginalParts().

◆ FindRow()

SYMBOL_LIB_TABLE_ROW * SYMBOL_LIB_TABLE::FindRow ( const wxString &  aNickName)

Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table fragment.

The SCH_PLUGIN is loaded and attached to the "plugin" fieldf the SYMBOL_LIB_TABLE_ROW if not already loaded.

Parameters
aNickNameis the name of the row to find.
Returns
the row found or NULL if aNickName was not found.
Exceptions
IO_ERRORif aNickName cannot be found.

Definition at line 283 of file symbol_lib_table.cpp.

285 {
286  SYMBOL_LIB_TABLE_ROW* row = dynamic_cast< SYMBOL_LIB_TABLE_ROW* >( findRow( aNickname ) );
287 
288  if( !row )
289  {
290  wxFAIL_MSG( "sym-lib-table files contain no library with nickname " + aNickname );
291  return nullptr;
292  }
293 
294  // We've been 'lazy' up until now, but it cannot be deferred any longer,
295  // instantiate a PLUGIN of the proper kind if it is not already in this
296  // SYMBOL_LIB_TABLE_ROW.
297  if( !row->plugin )
298  row->setPlugin( SCH_IO_MGR::FindPlugin( row->type ) );
299 
300  return row;
301 }
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
void setPlugin(SCH_PLUGIN *aPlugin)
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 LIB_TABLE::findRow(), SYMBOL_LIB_TABLE_ROW::plugin, SYMBOL_LIB_TABLE_ROW::setPlugin(), and SYMBOL_LIB_TABLE_ROW::type.

Referenced by CreateSymbolLib(), DeleteSymbol(), DeleteSymbolLib(), EnumerateSymbolLib(), LIB_MANAGER::GetLibrary(), GetModifyHash(), IsSymbolLibWritable(), SCH_EDIT_FRAME::LoadSheetFromFile(), LoadSymbol(), LoadSymbolLib(), and SaveSymbol().

◆ findRow() [1/2]

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

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 LIB_TABLE::ensureIndex(), LIB_TABLE::fallBack, LIB_TABLE::nickIndex, and LIB_TABLE::rows.

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

◆ findRow() [2/2]

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

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 LIB_TABLE::ensureIndex(), LIB_TABLE::fallBack, LIB_TABLE::nickIndex, and LIB_TABLE::rows.

◆ FindRowByURI()

const LIB_TABLE_ROW * LIB_TABLE::FindRowByURI ( const wxString &  aURI)
inherited
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 LIB_TABLE::ensureIndex(), LIB_TABLE::fallBack, and LIB_TABLE::rows.

Referenced by FOOTPRINT_EDIT_FRAME::KiwayMailIn(), and LIB_EDIT_FRAME::KiwayMailIn().

◆ Format()

void SYMBOL_LIB_TABLE::Format ( OUTPUTFORMATTER aOutput,
int  aIndentLevel 
) const
overridevirtual

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.

Implements LIB_TABLE.

Definition at line 228 of file symbol_lib_table.cpp.

229 {
230  aOutput->Print( aIndentLevel, "(sym_lib_table\n" );
231 
232  for( LIB_TABLE_ROWS_CITER it = rows.begin(); it != rows.end(); ++it )
233  {
234  it->Format( aOutput, aIndentLevel+1 );
235  }
236 
237  aOutput->Print( aIndentLevel, ")\n" );
238 }
LIB_TABLE_ROWS rows
LIB_TABLE_ROWS::const_iterator LIB_TABLE_ROWS_CITER
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404

References OUTPUTFORMATTER::Print(), and LIB_TABLE::rows.

Referenced by DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), and SCH_EAGLE_PLUGIN::Load().

◆ FormatOptions()

UTF8 LIB_TABLE::FormatOptions ( const PROPERTIES aProperties)
staticinherited

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
inlineinherited

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 LIB_TABLE::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)
inherited
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 LIB_TABLE::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
inherited

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 LIB_TABLE::findRow(), and LIB_TABLE_ROW::GetFullURI().

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

◆ GetGlobalLibTable()

◆ GetGlobalTableFileName()

wxString SYMBOL_LIB_TABLE::GetGlobalTableFileName ( )
static

Fetch the global symbol library table file name.

Returns
the platform specific global symbol library path and file name.

Definition at line 502 of file symbol_lib_table.cpp.

503 {
504  wxFileName fn;
505 
507  fn.SetName( global_tbl_name );
508 
509  return fn.GetFullPath();
510 }
static const wxString global_tbl_name("sym-lib-table")
static std::string GetUserSettingsPath()
Return the user configuration path used to store KiCad's configuration files.

References SETTINGS_MANAGER::GetUserSettingsPath(), and global_tbl_name().

Referenced by DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::GetGlobalTableFileName(), InvokeSchEditSymbolLibTable(), LoadGlobalTable(), SCH::IFACE::OnKifaceStart(), SCH_BASE_FRAME::saveSymbolLibTables(), and DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow().

◆ GetLogicalLibs()

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

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 LIB_TABLE::fallBack, numEval::lhs, and LIB_TABLE::rows.

Referenced by FP_TREE_MODEL_ADAPTER::AddLibraries(), CVPCB_MAINFRAME::BuildLIBRARY_LISTBOX(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), FP_LIB_TABLE::GenerateTimestamp(), GetModifyHash(), guessNickname(), CVPCB_MAINFRAME::LoadFootprintFiles(), 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().

◆ GetModifyHash()

int SYMBOL_LIB_TABLE::GetModifyHash ( )

Definition at line 241 of file symbol_lib_table.cpp.

242 {
243  int hash = 0;
244  std::vector< wxString > libNames = GetLogicalLibs();
245 
246  for( const auto& libName : libNames )
247  {
248  const SYMBOL_LIB_TABLE_ROW* row = FindRow( libName );
249 
250  if( !row || !row->plugin )
251  {
252  wxFAIL;
253  continue;
254  }
255 
256  hash += row->plugin->GetModifyHash();
257  }
258 
259  hash += m_modifyHash;
260 
261  return hash;
262 }
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
static int m_modifyHash
helper for GetModifyHash()
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.

References FindRow(), LIB_TABLE::GetLogicalLibs(), m_modifyHash, and SYMBOL_LIB_TABLE_ROW::plugin.

Referenced by LIB_MANAGER::GetHash(), and LIB_MANAGER::Sync().

◆ GetSymbolLibTableFileName()

◆ GlobalPathEnvVariableName()

const wxString SYMBOL_LIB_TABLE::GlobalPathEnvVariableName ( )
static

Return the name of the environment variable used to hold the directory of locally installed "KiCad sponsored" system symbol libraries.

These can be either legacy or sweet format. The only thing special about this particular environment variable is that it is set automatically by KiCad on program start up, if it is not set already in the environment.

Definition at line 452 of file symbol_lib_table.cpp.

453 {
454  return "KICAD_SYMBOL_DIR";
455 }

Referenced by PANEL_SYM_LIB_TABLE::populateEnvironReadOnlyTable().

◆ HasLibrary()

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

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 LIB_TABLE::findRow(), and LIB_TABLE_ROW::GetIsEnabled().

Referenced by CVPCB_MAINFRAME::DisplayStatus(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), InvokeSchEditSymbolLibTable(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), LIB_EDIT_FRAME::KiwayMailIn(), LIB_MANAGER::LibraryExists(), SCH_EAGLE_PLUGIN::Load(), SCH_EDIT_FRAME::LoadSheetFromFile(), 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 
)
inherited

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 LIB_TABLE::ensureIndex(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE::nickIndex, and LIB_TABLE::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 Parse().

◆ IsEmpty()

bool LIB_TABLE::IsEmpty ( bool  aIncludeFallback = true)
inherited

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 LIB_TABLE::fallBack, LIB_TABLE::IsEmpty(), and LIB_TABLE::rows.

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

◆ IsSymbolLibWritable()

bool SYMBOL_LIB_TABLE::IsSymbolLibWritable ( const wxString &  aNickname)

Return true if the library given by aNickname is writable.

It is possible that some symbols libraries are read only because of where they are installed.

Parameters
aNicknameis the library nickname in the symbol library table.
Exceptions
IO_ERRORif no library at aNickname exists.

Definition at line 397 of file symbol_lib_table.cpp.

398 {
399  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
400  wxCHECK( row && row->plugin, false );
401  return row->plugin->IsSymbolLibWritable( row->GetFullURI( true ) );
402 }
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
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(), LIB_TABLE_ROW::GetFullURI(), and SYMBOL_LIB_TABLE_ROW::plugin.

Referenced by LIB_MANAGER::IsLibraryReadOnly().

◆ Load()

void LIB_TABLE::Load ( const wxString &  aFileName)
inherited

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 LIB_TABLE::Parse().

Referenced by 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().

◆ LoadGlobalTable()

bool SYMBOL_LIB_TABLE::LoadGlobalTable ( SYMBOL_LIB_TABLE aTable)
static

Load the global symbol library table into aTable.

This probably should be move into the application object when KiCad is changed to a single process application. This is the least painful solution for the time being.

Parameters
aTablethe SYMBOL_LIB_TABLE object to load.
Returns
true if the global library table exists and is loaded properly.
Exceptions
IO_ERRORif an error occurs attempting to load the symbol library table.

Definition at line 458 of file symbol_lib_table.cpp.

459 {
460  bool tableExists = true;
461  wxFileName fn = GetGlobalTableFileName();
462 
463  if( !fn.FileExists() )
464  {
465  tableExists = false;
466 
467  if( !fn.DirExists() && !fn.Mkdir( 0x777, wxPATH_MKDIR_FULL ) )
468  {
469  THROW_IO_ERROR( wxString::Format( _( "Cannot create global library table path \"%s\"." ),
470  GetChars( fn.GetPath() ) ) );
471  }
472 
473  // Attempt to copy the default global file table from the KiCad
474  // template folder to the user's home configuration path.
475  SEARCH_STACK ss;
476 
477  SystemDirsAppend( &ss );
478 
479  wxString templatePath =
480  Pgm().GetLocalEnvVariables().at( wxT( "KICAD_TEMPLATE_DIR" ) ).GetValue();
481 
482  if( !templatePath.IsEmpty() )
483  ss.AddPaths( templatePath, 0 );
484 
485  wxString fileName = ss.FindValidPath( global_tbl_name );
486 
487  // The fallback is to create an empty global symbol table for the user to populate.
488  if( fileName.IsEmpty() || !::wxCopyFile( fileName, fn.GetFullPath(), false ) )
489  {
490  SYMBOL_LIB_TABLE emptyTable;
491 
492  emptyTable.Save( fn.GetFullPath() );
493  }
494  }
495 
496  aTable.Load( fn.GetFullPath() );
497 
498  return tableExists;
499 }
wxString FindValidPath(const wxString &aFileName) const
Definition: search_stack.h:73
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
SEARCH_STACK looks for files in a number of places.
Definition: search_stack.h:41
static const wxString global_tbl_name("sym-lib-table")
void SystemDirsAppend(SEARCH_STACK *aSearchStack)
Function SystemDirsAppend appends system places to aSearchStack in a platform specific way,...
#define THROW_IO_ERROR(msg)
void Load(const wxString &aFileName)
Load the library table using the path defined by aFileName aFallBackTable.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:153
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
#define _(s)
Definition: 3d_actions.cpp:33
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
static wxString GetGlobalTableFileName()
Fetch the global symbol library table file name.
void AddPaths(const wxString &aPaths, int aIndex=-1)
Function AddPaths insert or append path(s)

References _, SEARCH_STACK::AddPaths(), SEARCH_STACK::FindValidPath(), Format(), GetChars(), GetGlobalTableFileName(), global_tbl_name(), LIB_TABLE::Load(), Pgm(), LIB_TABLE::Save(), SystemDirsAppend(), and THROW_IO_ERROR.

Referenced by SCH::IFACE::OnKifaceStart(), and DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow().

◆ LoadSymbol() [1/2]

LIB_PART * SYMBOL_LIB_TABLE::LoadSymbol ( const wxString &  aNickname,
const wxString &  aName 
)

Load a LIB_PART having aName from the library given by aNickname.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW
aNameis the name of the LIB_PART to load.
aFlattenset to true to flatten derived parts.
Returns
the symbol alias if found or NULL if not found.
Exceptions
IO_ERRORif the library cannot be found or read. No exception is thrown in the case where aNickname cannot be found.

Definition at line 334 of file symbol_lib_table.cpp.

335 {
336  SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
337  wxCHECK( row && row->plugin, nullptr );
338 
339  LIB_PART* part = row->plugin->LoadSymbol( row->GetFullURI( true ), aSymbolName,
340  row->GetProperties() );
341 
342  if( part == nullptr )
343  return part;
344 
345  // The library cannot know its own name, because it might have been renamed or moved.
346  // Therefore footprints cannot know their own library nickname when residing in
347  // a symbol library.
348  // Only at this API layer can we tell the symbol about its actual library nickname.
349  if( part )
350  {
351  LIB_ID id = part->GetLibId();
352 
353  id.SetLibNickname( row->GetNickName() );
354  part->SetLibId( id );
355  }
356 
357  return part;
358 }
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
LIB_ID GetLibId() const override
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
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...
const wxString & GetNickName() const
Define a library symbol object.
int SetLibNickname(const UTF8 &aNickname)
Override the logical library name portion of the LIB_ID to aNickname.
Definition: lib_id.cpp:193
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).
void SetLibId(const LIB_ID &aLibId)

References FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_PART::GetLibId(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE_ROW::GetProperties(), SYMBOL_LIB_TABLE_ROW::plugin, LIB_PART::SetLibId(), and LIB_ID::SetLibNickname().

Referenced by FOOTPRINT_INFO_GENERATOR::GenerateHtml(), LIB_MANAGER::GetAlias(), LIB_MANAGER::GetBufferedPart(), LIB_MANAGER::getOriginalParts(), SCH_EAGLE_PLUGIN::loadInstance(), LoadSymbol(), LoadSymbolWithOptionalNickname(), LIB_MANAGER::PartExists(), LIB_MANAGER::LIB_BUFFER::SaveBuffer(), SchGetLibPart(), and SCH_SCREEN::UpdateSymbolLinks().

◆ LoadSymbol() [2/2]

LIB_PART* SYMBOL_LIB_TABLE::LoadSymbol ( const LIB_ID aLibId)
inline

Definition at line 178 of file symbol_lib_table.h.

179  {
180  return LoadSymbol( aLibId.GetLibNickname(), aLibId.GetLibItemName() );
181  }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
LIB_PART * LoadSymbol(const wxString &aNickname, const wxString &aName)
Load a LIB_PART having aName from the library given by aNickname.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), and LoadSymbol().

◆ LoadSymbolLib()

void SYMBOL_LIB_TABLE::LoadSymbolLib ( std::vector< LIB_PART * > &  aAliasList,
const wxString &  aNickname,
bool  aPowerSymbolsOnly = false 
)

Definition at line 304 of file symbol_lib_table.cpp.

306 {
307  SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
308  wxCHECK( row && row->plugin, /* void */ );
309 
310  wxString options = row->GetOptions();
311 
312  if( aPowerSymbolsOnly )
313  row->SetOptions( row->GetOptions() + " " + PropPowerSymsOnly );
314 
315  row->plugin->EnumerateSymbolLib( aSymbolList, row->GetFullURI( true ), row->GetProperties() );
316 
317  if( aPowerSymbolsOnly )
318  row->SetOptions( options );
319 
320  // The library cannot know its own name, because it might have been renamed or moved.
321  // Therefore footprints cannot know their own library nickname when residing in
322  // a symbol library.
323  // Only at this API layer can we tell the symbol about its actual library nickname.
324  for( LIB_PART* part : aSymbolList )
325  {
326  LIB_ID id = part->GetLibId();
327 
328  id.SetLibNickname( row->GetNickName() );
329  part->SetLibId( id );
330  }
331 }
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
const wxString & GetOptions() const
Return the options string, which may hold a password or anything else needed to instantiate the under...
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
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...
const wxString & GetNickName() const
Define a library symbol object.
int SetLibNickname(const UTF8 &aNickname)
Override the logical library name portion of the LIB_ID to aNickname.
Definition: lib_id.cpp:193
void SetOptions(const wxString &aOptions)
Change the library options strings.
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).
static const char * PropPowerSymsOnly

References FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE_ROW::GetOptions(), LIB_TABLE_ROW::GetProperties(), SYMBOL_LIB_TABLE_ROW::plugin, PropPowerSymsOnly, LIB_ID::SetLibNickname(), and LIB_TABLE_ROW::SetOptions().

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), and LIB_MANAGER::GetAliases().

◆ LoadSymbolWithOptionalNickname()

LIB_PART * SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname ( const LIB_ID aId)

Load a LIB_PART having aFootprintId with possibly an empty library nickname.

Parameters
aIdthe library nickname and name of the symbol to load.
Returns
the library symbol if found (the library owns it) or NULL if not found.
Exceptions
IO_ERRORif the library cannot be found or read. No exception is thrown in the case where aId cannot be found.
PARSE_ERRORif aId is not parsed OK.

Definition at line 421 of file symbol_lib_table.cpp.

422 {
423  wxString nickname = aLibId.GetLibNickname();
424  wxString name = aLibId.GetLibItemName();
425 
426  if( nickname.size() )
427  {
428  return LoadSymbol( nickname, name );
429  }
430 
431  // nickname is empty, sequentially search (alphabetically) all libs/nicks for first match:
432  else
433  {
434  std::vector<wxString> nicks = GetLogicalLibs();
435 
436  // Search each library going through libraries alphabetically.
437  for( unsigned i = 0; i < nicks.size(); ++i )
438  {
439  // FootprintLoad() returns NULL on not found, does not throw exception
440  // unless there's an IO_ERROR.
441  LIB_PART* ret = LoadSymbol( nicks[i], name );
442 
443  if( ret )
444  return ret;
445  }
446 
447  return nullptr;
448  }
449 }
LIB_PART * LoadSymbol(const wxString &aNickname, const wxString &aName)
Load a LIB_PART having aName from the library given by aNickname.
Define a library symbol object.
const char * name
Definition: DXF_plotter.cpp:60
std::vector< wxString > GetLogicalLibs()
Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_TABLE::GetLogicalLibs(), LoadSymbol(), and name.

◆ operator!=()

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

Definition at line 336 of file lib_table_base.h.

336 { return !( *this == r ); }

◆ operator==()

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

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 LIB_TABLE::rows.

◆ Parse()

void SYMBOL_LIB_TABLE::Parse ( LIB_TABLE_LEXER *  aLexer)
overridevirtual

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.

Implements LIB_TABLE.

Definition at line 86 of file symbol_lib_table.cpp.

87 {
88  T tok;
89  wxString errMsg; // to collect error messages
90 
91  // This table may be nested within a larger s-expression, or not.
92  // Allow for parser of that optional containing s-epression to have looked ahead.
93  if( in->CurTok() != T_sym_lib_table )
94  {
95  in->NeedLEFT();
96  if( ( tok = in->NextTok() ) != T_sym_lib_table )
97  in->Expecting( T_sym_lib_table );
98  }
99 
100  while( ( tok = in->NextTok() ) != T_RIGHT )
101  {
102  std::unique_ptr< SYMBOL_LIB_TABLE_ROW > row( new SYMBOL_LIB_TABLE_ROW );
103 
104  if( tok == T_EOF )
105  in->Expecting( T_RIGHT );
106 
107  if( tok != T_LEFT )
108  in->Expecting( T_LEFT );
109 
110  // in case there is a "row integrity" error, tell where later.
111  int lineNum = in->CurLineNumber();
112 
113  if( ( tok = in->NextTok() ) != T_lib )
114  in->Expecting( T_lib );
115 
116  // (name NICKNAME)
117  in->NeedLEFT();
118 
119  if( ( tok = in->NextTok() ) != T_name )
120  in->Expecting( T_name );
121 
122  in->NeedSYMBOLorNUMBER();
123 
124  row->SetNickName( in->FromUTF8() );
125 
126  in->NeedRIGHT();
127 
128  // After (name), remaining (lib) elements are order independent, and in
129  // some cases optional.
130  bool sawType = false;
131  bool sawOpts = false;
132  bool sawDesc = false;
133  bool sawUri = false;
134  bool sawDisabled = false;
135 
136  while( ( tok = in->NextTok() ) != T_RIGHT )
137  {
138  if( tok == T_EOF )
139  in->Unexpected( T_EOF );
140 
141  if( tok != T_LEFT )
142  in->Expecting( T_LEFT );
143 
144  tok = in->NeedSYMBOLorNUMBER();
145 
146  switch( tok )
147  {
148  case T_uri:
149  if( sawUri )
150  in->Duplicate( tok );
151  sawUri = true;
152  in->NeedSYMBOLorNUMBER();
153  row->SetFullURI( in->FromUTF8() );
154  break;
155 
156  case T_type:
157  if( sawType )
158  in->Duplicate( tok );
159  sawType = true;
160  in->NeedSYMBOLorNUMBER();
161  row->SetType( in->FromUTF8() );
162  break;
163 
164  case T_options:
165  if( sawOpts )
166  in->Duplicate( tok );
167  sawOpts = true;
168  in->NeedSYMBOLorNUMBER();
169  row->SetOptions( in->FromUTF8() );
170  break;
171 
172  case T_descr:
173  if( sawDesc )
174  in->Duplicate( tok );
175  sawDesc = true;
176  in->NeedSYMBOLorNUMBER();
177  row->SetDescr( in->FromUTF8() );
178  break;
179 
180  case T_disabled:
181  if( sawDisabled )
182  in->Duplicate( tok );
183  sawDisabled = true;
184  row->SetEnabled( false );
185  break;
186 
187  default:
188  in->Unexpected( tok );
189  }
190 
191  in->NeedRIGHT();
192  }
193 
194  if( !sawType )
195  in->Expecting( T_type );
196 
197  if( !sawUri )
198  in->Expecting( T_uri );
199 
200  // all nickNames within this table fragment must be unique, so we do not
201  // use doReplace in InsertRow(). (However a fallBack table can have a
202  // conflicting nickName and ours will supercede that one since in
203  // FindLib() we search this table before any fall back.)
204  wxString nickname = row->GetNickName(); // store it to be able to used it
205  // after row deletion if an error occurs
206  LIB_TABLE_ROW* tmp = row.release();
207 
208  if( !InsertRow( tmp ) )
209  {
210  delete tmp; // The table did not take ownership of the row.
211 
212  wxString msg = wxString::Format(
213  _( "Duplicate library nickname \"%s\" found in symbol library "
214  "table file line %d" ), GetChars( nickname ), lineNum );
215 
216  if( !errMsg.IsEmpty() )
217  errMsg << '\n';
218 
219  errMsg << msg;
220  }
221  }
222 
223  if( !errMsg.IsEmpty() )
224  THROW_IO_ERROR( errMsg );
225 }
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
bool InsertRow(LIB_TABLE_ROW *aRow, bool doReplace=false)
Adds aRow if it does not already exist or if doReplace is true.
#define THROW_IO_ERROR(msg)
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:153
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
#define _(s)
Definition: 3d_actions.cpp:33

References _, Format(), GetChars(), LIB_TABLE::InsertRow(), and THROW_IO_ERROR.

Referenced by SYMBOL_GRID_TRICKS::paste_text().

◆ ParseOptions()

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

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

Definition at line 490 of file lib_table_base.h.

491  {
492  nickIndex.clear();
493 
494  for( LIB_TABLE_ROWS_ITER it = rows.begin(); it != rows.end(); ++it )
495  nickIndex.insert( INDEX_VALUE( it->GetNickName(), it - rows.begin() ) );
496  }
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 LIB_TABLE::nickIndex, and LIB_TABLE::rows.

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

◆ RemoveRow()

bool LIB_TABLE::RemoveRow ( LIB_TABLE_ROW aRow)
inlineinherited

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 LIB_TABLE::rows.

Referenced by LIB_MANAGER::addLibrary().

◆ Save()

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

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 LIB_TABLE::Format().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), PCB_EDIT_FRAME::importFile(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), SCH_BASE_FRAME::saveSymbolLibTables(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow(), and DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow().

◆ SaveSymbol()

SYMBOL_LIB_TABLE::SAVE_T SYMBOL_LIB_TABLE::SaveSymbol ( const wxString &  aNickname,
const LIB_PART aSymbol,
bool  aOverwrite = true 
)

Write aSymbol to an existing library given by aNickname.

If a LIB_PART by the same name already exists or there are any conflicting alias names, the new LIB_PART will silently overwrite any existing aliases and/or part becaue libraries cannot have duplicate alias names. It is the responsibility of the caller to check the library for conflicts before saving.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW
aSymbolis what to store in the library. The library owns the symbol after this call.
aOverwritewhen true means overwrite any existing symbol by the same name, else if false means skip the write and return SAVE_SKIPPED.
Returns
SAVE_T - SAVE_OK or SAVE_SKIPPED. If error saving, then IO_ERROR is thrown.
Exceptions
IO_ERRORif there is a problem saving the symbol.

Definition at line 361 of file symbol_lib_table.cpp.

363 {
364  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
365  wxCHECK( row && row->plugin, SAVE_SKIPPED );
366 
367  if( !aOverwrite )
368  {
369  // Try loading the footprint to see if it already exists, caller wants overwrite
370  // protection, which is atypical, not the default.
371 
372  wxString name = aSymbol->GetLibId().GetLibItemName();
373 
374  std::unique_ptr< LIB_PART > symbol( row->plugin->LoadSymbol( row->GetFullURI( true ),
375  name,
376  row->GetProperties() ) );
377 
378  if( symbol.get() )
379  return SAVE_SKIPPED;
380  }
381 
382  row->plugin->SaveSymbol( row->GetFullURI( true ), aSymbol, row->GetProperties() );
383 
384  return SAVE_OK;
385 }
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
LIB_ID GetLibId() const override
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
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...
const char * name
Definition: DXF_plotter.cpp:60
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).

References FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_PART::GetLibId(), LIB_ID::GetLibItemName(), LIB_TABLE_ROW::GetProperties(), name, SYMBOL_LIB_TABLE_ROW::plugin, SAVE_OK, and SAVE_SKIPPED.

Referenced by LIB_MANAGER::LIB_BUFFER::SaveBuffer().

◆ Type()

KICAD_T SYMBOL_LIB_TABLE::Type ( )
inlineoverridevirtual

Implements PROJECT::_ELEM.

Definition at line 111 of file symbol_lib_table.h.

References SYMBOL_LIB_TABLE_T.

Friends And Related Function Documentation

◆ PANEL_SYM_LIB_TABLE

friend class PANEL_SYM_LIB_TABLE
friend

Definition at line 106 of file symbol_lib_table.h.

◆ SYMBOL_LIB_TABLE_GRID

friend class SYMBOL_LIB_TABLE_GRID
friend

Definition at line 105 of file symbol_lib_table.h.

Member Data Documentation

◆ fallBack

LIB_TABLE* LIB_TABLE::fallBack
protectedinherited

◆ m_modifyHash

int SYMBOL_LIB_TABLE::m_modifyHash = 1
staticprivate

helper for GetModifyHash()

Definition at line 108 of file symbol_lib_table.h.

Referenced by GetModifyHash().

◆ nickIndex

INDEX LIB_TABLE::nickIndex
protectedinherited

this particular key is the nickName within each row.

Definition at line 516 of file lib_table_base.h.

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

◆ PropNonPowerSymsOnly

const char * SYMBOL_LIB_TABLE::PropNonPowerSymsOnly = "non_pwr_sym_only"
static

Definition at line 114 of file symbol_lib_table.h.

◆ PropPowerSymsOnly

const char * SYMBOL_LIB_TABLE::PropPowerSymsOnly = "pwr_sym_only"
static

◆ rows


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