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, bool aCheckIfEnabled=false)
 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...
 
bool IsSymbolLibLoaded (const wxString &aNickname)
 Return true if the library given by aNickname was successfully loaded. 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, bool aCheckIfEnabled=false) const
 Return a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBack table fragment, else NULL. More...
 
void reindex ()
 
void ensureIndex ()
 

Protected Attributes

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

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

◆ INDEX_CITER

typedef INDEX::const_iterator LIB_TABLE::INDEX_CITER
protectedinherited

Definition at line 529 of file lib_table_base.h.

◆ INDEX_ITER

typedef INDEX::iterator LIB_TABLE::INDEX_ITER
protectedinherited

Definition at line 528 of file lib_table_base.h.

◆ INDEX_VALUE

typedef INDEX::value_type LIB_TABLE::INDEX_VALUE
protectedinherited

Definition at line 530 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 190 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 88 of file symbol_lib_table.cpp.

88  :
89  LIB_TABLE( aFallBackTable )
90 {
91  // not copying fall back, simply search aFallBackTable separately
92  // if "nickName not found".
93 }
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 362 of file lib_table_base.h.

363  {
364  return rows[aIndex];
365  }
LIB_TABLE_ROWS rows

References LIB_TABLE::rows.

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

◆ At() [2/2]

const LIB_TABLE_ROW& LIB_TABLE::At ( unsigned  aIndex) const
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 370 of file lib_table_base.h.

371  {
372  return rows[aIndex];
373  }
LIB_TABLE_ROWS rows

References LIB_TABLE::rows.

◆ Clear()

void LIB_TABLE::Clear ( )
inlineinherited

Delete all rows.

Definition at line 319 of file lib_table_base.h.

320  {
321  rows.clear();
322  nickIndex.clear();
323  }
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 450 of file symbol_lib_table.cpp.

451 {
452  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
453  wxCHECK( row && row->plugin, /* void */ );
454  row->plugin->CreateSymbolLib( row->GetFullURI( true ), row->GetProperties() );
455 }
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).
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...

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

Referenced by SYMBOL_LIBRARY_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 418 of file symbol_lib_table.cpp.

419 {
420  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
421  wxCHECK( row && row->plugin, /* void */ );
422  return row->plugin->DeleteSymbol( row->GetFullURI( true ), aSymbolName,
423  row->GetProperties() );
424 }
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).
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...

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

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

◆ DeleteSymbolLib()

void SYMBOL_LIB_TABLE::DeleteSymbolLib ( const wxString &  aNickname)

Definition at line 442 of file symbol_lib_table.cpp.

443 {
444  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
445  wxCHECK( row && row->plugin, /* void */ );
446  row->plugin->DeleteSymbolLib( row->GetFullURI( true ), row->GetProperties() );
447 }
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).
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...

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

511  {
512  // The dialog lib table editor may not maintain the nickIndex.
513  // Lazy indexing may be required. To handle lazy indexing, we must enforce
514  // that "nickIndex" is either empty or accurate, but never inaccurate.
515  if( !nickIndex.size() )
516  reindex();
517  }
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 282 of file symbol_lib_table.cpp.

284 {
285  SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
286  wxCHECK( row && row->plugin, /* void */ );
287 
288  wxString options = row->GetOptions();
289 
290  if( aPowerSymbolsOnly )
291  row->SetOptions( row->GetOptions() + " " + PropPowerSymsOnly );
292 
293  row->SetLoaded( false );
294  row->plugin->EnumerateSymbolLib( aAliasNames, row->GetFullURI( true ), row->GetProperties() );
295  row->SetLoaded( true );
296 
297  if( aPowerSymbolsOnly )
298  row->SetOptions( options );
299 }
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 SetLoaded(bool aLoaded)
Mark the row as being a loaded library.
void SetOptions(const wxString &aOptions)
Change the library options strings.
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
static const char * PropPowerSymsOnly

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

Referenced by SYMBOL_LIBRARY_MANAGER::getOriginalParts().

◆ FindRow()

SYMBOL_LIB_TABLE_ROW * SYMBOL_LIB_TABLE::FindRow ( const wxString &  aNickName,
bool  aCheckIfEnabled = false 
)

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.
aCheckIfEnabledis a flag to verify if the table entry is enabled or disabled.
Returns
the row found or NULL if aNickName was not found.

Definition at line 302 of file symbol_lib_table.cpp.

303 {
304  SYMBOL_LIB_TABLE_ROW* row =
305  dynamic_cast< SYMBOL_LIB_TABLE_ROW* >( findRow( aNickname, aCheckIfEnabled ) );
306 
307  if( !row )
308  return nullptr;
309 
310  // We've been 'lazy' up until now, but it cannot be deferred any longer,
311  // instantiate a PLUGIN of the proper kind if it is not already in this
312  // SYMBOL_LIB_TABLE_ROW.
313  if( !row->plugin )
314  row->setPlugin( SCH_IO_MGR::FindPlugin( row->type ) );
315 
316  return row;
317 }
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
LIB_TABLE_ROW * findRow(const wxString &aNickname, bool aCheckIfEnabled=false) const
Return a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBack table fragment,...
void setPlugin(SCH_PLUGIN *aPlugin)

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(), SYMBOL_LIBRARY_MANAGER::GetLibrary(), GetModifyHash(), IsSymbolLibLoaded(), IsSymbolLibWritable(), SCH_EDIT_FRAME::LoadSheetFromFile(), LoadSymbol(), LoadSymbolLib(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SaveSymbol(), and ERC_TESTER::TestLibSymbolIssues().

◆ findRow()

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

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

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

Definition at line 183 of file lib_table_base.cpp.

184 {
185  LIB_TABLE_ROW* row = nullptr;
186  LIB_TABLE* cur = (LIB_TABLE*) this;
187 
188  do
189  {
190  cur->ensureIndex();
191 
192  for( const std::pair<const wxString, int>& entry : cur->nickIndex )
193  {
194  if( entry.first == aNickName )
195  {
196  row = &cur->rows[entry.second];
197 
198  if( !aCheckIfEnabled || ( aCheckIfEnabled && row->GetIsEnabled() ) )
199  return row;
200  }
201  }
202 
203  // Repeat, this time looking for names that were "fixed" by legacy versions because
204  // the old eeschema file format didn't support spaces in tokens.
205  for( const std::pair<const wxString, int>& entry : cur->nickIndex )
206  {
207  wxString legacyLibName = entry.first;
208  legacyLibName.Replace( " ", "_" );
209 
210  if( legacyLibName == aNickName )
211  {
212  row = &cur->rows[entry.second];
213 
214  if( !aCheckIfEnabled || ( aCheckIfEnabled && row->GetIsEnabled() ) )
215  return row;
216  }
217  }
218 
219  // not found, search fall back table(s), if any
220  } while( ( cur = cur->fallBack ) != 0 );
221 
222  return nullptr; // not found
223 }
void ensureIndex()
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
LIB_TABLE_ROWS rows
LIB_TABLE * fallBack
bool GetIsEnabled() const
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_ROW::GetIsEnabled(), LIB_TABLE::nickIndex, and LIB_TABLE::rows.

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

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

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

246 {
247  aOutput->Print( aIndentLevel, "(sym_lib_table\n" );
248 
249  for( LIB_TABLE_ROWS_CITER it = rows.begin(); it != rows.end(); ++it )
250  {
251  it->Format( aOutput, aIndentLevel+1 );
252  }
253 
254  aOutput->Print( aIndentLevel, ")\n" );
255 }
LIB_TABLE_ROWS rows
LIB_TABLE_ROWS::const_iterator LIB_TABLE_ROWS_CITER
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:408

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

Referenced by DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), 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 407 of file lib_table_base.cpp.

408 {
409  UTF8 ret;
410 
411  if( aProperties )
412  {
413  for( PROPERTIES::const_iterator it = aProperties->begin(); it != aProperties->end(); ++it )
414  {
415  const std::string& name = it->first;
416 
417  const UTF8& value = it->second;
418 
419  if( ret.size() )
420  ret += OPT_SEP;
421 
422  ret += name;
423 
424  // the separation between name and value is '='
425  if( value.size() )
426  {
427  ret += '=';
428 
429  for( std::string::const_iterator si = value.begin(); si != value.end(); ++si )
430  {
431  // escape any separator in the value.
432  if( *si == OPT_SEP )
433  ret += '\\';
434 
435  ret += *si;
436  }
437  }
438  }
439  }
440 
441  return ret;
442 }
An 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to and fro...
Definition: utf8.h:70
const char * name
Definition: DXF_plotter.cpp:59
std::string::const_iterator end() const
Definition: utf8.h:193
std::string::const_iterator begin() const
Definition: utf8.h:192
std::string::size_type size() const
Definition: utf8.h:110
#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 352 of file lib_table_base.h.

353  {
354  return rows.size();
355  }
LIB_TABLE_ROWS rows

References LIB_TABLE::rows.

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

◆ GetDescription()

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

Definition at line 147 of file lib_table_base.cpp.

148 {
149  // Use "no exception" form of find row and ignore disabled flag.
150  const LIB_TABLE_ROW* row = findRow( aNickname );
151 
152  if( row )
153  return row->GetDescr();
154  else
155  return wxEmptyString;
156 }
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, bool aCheckIfEnabled=false) 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(), SYMBOL_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 170 of file lib_table_base.cpp.

171 {
172  const LIB_TABLE_ROW* row = findRow( aNickname, true );
173 
174  wxString retv;
175 
176  if( row )
177  retv = row->GetFullURI( aExpandEnvVars );
178 
179  return retv;
180 }
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, bool aCheckIfEnabled=false) 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(), NETLIST_EXPORTER_XML::makeLibraries(), and FOOTPRINT_EDITOR_CONTROL::SaveAs().

◆ 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 539 of file symbol_lib_table.cpp.

540 {
541  wxFileName fn;
542 
544  fn.SetName( global_tbl_name );
545 
546  return fn.GetFullPath();
547 }
static const wxString global_tbl_name("sym-lib-table")
static wxString GetUserSettingsPath()
Return the user configuration path used to store KiCad's configuration files.

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

Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::GetGlobalTableFileName(), InvokeSchEditSymbolLibTable(), LoadGlobalTable(), SCH::IFACE::OnKifaceStart(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), 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 262 of file lib_table_base.cpp.

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

References LIB_TABLE::fallBack, 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(), GetFootprintLibraries(), GetModifyHash(), guessNickname(), CVPCB_MAINFRAME::LoadFootprintFiles(), LoadSymbolWithOptionalNickname(), FOOTPRINT_VIEWER_FRAME::OnActivate(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_BASE_FRAME::PickSymbolFromLibTree(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::savePartAs(), PCB_BASE_FRAME::SelectLibrary(), FOOTPRINT_LIST_IMPL::startWorkers(), and FP_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ GetModifyHash()

int SYMBOL_LIB_TABLE::GetModifyHash ( )

Definition at line 258 of file symbol_lib_table.cpp.

259 {
260  int hash = 0;
261  std::vector< wxString > libNames = GetLogicalLibs();
262 
263  for( const auto& libName : libNames )
264  {
265  const SYMBOL_LIB_TABLE_ROW* row = FindRow( libName, true );
266 
267  if( !row || !row->plugin )
268  {
269  wxFAIL;
270  continue;
271  }
272 
273  hash += row->plugin->GetModifyHash();
274  }
275 
276  hash += m_modifyHash;
277 
278  return hash;
279 }
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()
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
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 SYMBOL_LIBRARY_MANAGER::GetHash(), and SYMBOL_LIBRARY_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 489 of file symbol_lib_table.cpp.

490 {
491  return "KICAD6_SYMBOL_DIR";
492 }

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

160 {
161  const LIB_TABLE_ROW* row = findRow( aNickname, aCheckEnabled );
162 
163  if( row == nullptr )
164  return false;
165 
166  return true;
167 }
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
LIB_TABLE_ROW * findRow(const wxString &aNickname, bool aCheckIfEnabled=false) const
Return a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBack table fragment,...

References LIB_TABLE::findRow().

Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry(), CVPCB_MAINFRAME::DisplayStatus(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_LIBRARY_MANAGER::LibraryExists(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_EDIT_FRAME::LoadSheetFromFile(), NETLIST_EXPORTER_XML::makeLibraries(), SCH_BASE_FRAME::PickSymbolFromLibTree(), SYMBOL_VIEWER_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), ERC_TESTER::TestLibSymbolIssues(), 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 302 of file lib_table_base.cpp.

303 {
304  ensureIndex();
305 
306  INDEX_CITER it = nickIndex.find( aRow->GetNickName() );
307 
308  if( it == nickIndex.end() )
309  {
310  rows.push_back( aRow );
311  nickIndex.insert( INDEX_VALUE( aRow->GetNickName(), rows.size() - 1 ) );
312  return true;
313  }
314 
315  if( doReplace )
316  {
317  rows.replace( it->second, aRow );
318  return true;
319  }
320 
321  return false;
322 }
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(), SYMBOL_LIBRARY_MANAGER::addLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), LIB_TABLE_TEST_FIXTURE::LIB_TABLE_TEST_FIXTURE(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), PCB_EDIT_FRAME::OpenProjectFiles(), 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 138 of file lib_table_base.cpp.

139 {
140  if( !aIncludeFallback || !fallBack )
141  return rows.empty();
142 
143  return rows.empty() && fallBack->IsEmpty( true );
144 }
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().

◆ IsSymbolLibLoaded()

bool SYMBOL_LIB_TABLE::IsSymbolLibLoaded ( const wxString &  aNickname)

Return true if the library given by aNickname was successfully loaded.

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

Definition at line 434 of file symbol_lib_table.cpp.

435 {
436  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
437  wxCHECK( row, false );
438  return row->GetIsLoaded();
439 }
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
bool GetIsLoaded() const
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...

References FindRow(), and LIB_TABLE_ROW::GetIsLoaded().

Referenced by SYMBOL_LIBRARY_MANAGER::IsLibraryLoaded().

◆ 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 427 of file symbol_lib_table.cpp.

428 {
429  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
430  wxCHECK( row && row->plugin, false );
431  return row->plugin->IsSymbolLibWritable( row->GetFullURI( true ) );
432 }
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...
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...

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

Referenced by SYMBOL_LIBRARY_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 325 of file lib_table_base.cpp.

327 {
328  // It's OK if footprint library tables are missing.
329  if( wxFileName::IsFileReadable( aFileName ) )
330  {
331  FILE_LINE_READER reader( aFileName );
332  LIB_TABLE_LEXER lexer( &reader );
333 
334  Parse( &lexer );
335  }
336 }
A LINE_READER that reads from an open file.
Definition: richio.h:172
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 FP_LIB_TABLE::LoadGlobalTable(), LoadGlobalTable(), SCH_EDIT_FRAME::LoadSheetFromFile(), PROJECT::PcbFootprintLibs(), SCH::IFACE::SaveFileAs(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow(), and DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow().

◆ 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 495 of file symbol_lib_table.cpp.

496 {
497  bool tableExists = true;
498  wxFileName fn = GetGlobalTableFileName();
499 
500  if( !fn.FileExists() )
501  {
502  tableExists = false;
503 
504  if( !fn.DirExists() && !fn.Mkdir( 0x777, wxPATH_MKDIR_FULL ) )
505  {
507  _( "Cannot create global library table path \"%s\"." ), fn.GetPath() ) );
508  }
509 
510  // Attempt to copy the default global file table from the KiCad
511  // template folder to the user's home configuration path.
512  SEARCH_STACK ss;
513 
514  SystemDirsAppend( &ss );
515 
516  wxString templatePath =
517  Pgm().GetLocalEnvVariables().at( wxT( "KICAD6_TEMPLATE_DIR" ) ).GetValue();
518 
519  if( !templatePath.IsEmpty() )
520  ss.AddPaths( templatePath, 0 );
521 
522  wxString fileName = ss.FindValidPath( global_tbl_name );
523 
524  // The fallback is to create an empty global symbol table for the user to populate.
525  if( fileName.IsEmpty() || !::wxCopyFile( fileName, fn.GetFullPath(), false ) )
526  {
527  SYMBOL_LIB_TABLE emptyTable;
528 
529  emptyTable.Save( fn.GetFullPath() );
530  }
531  }
532 
533  aTable.Load( fn.GetFullPath() );
534 
535  return tableExists;
536 }
wxString FindValidPath(const wxString &aFileName) const
Definition: search_stack.h:70
Look for files in a number of paths.
Definition: search_stack.h:41
static const wxString global_tbl_name("sym-lib-table")
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void SystemDirsAppend(SEARCH_STACK *aSearchStack)
Append system places to aSearchStack in a platform specific way and pertinent to KiCad programs.
void Load(const wxString &aFileName)
Load the library table using the path defined by aFileName aFallBackTable.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:38
static wxString GetGlobalTableFileName()
Fetch the global symbol library table file name.
void AddPaths(const wxString &aPaths, int aIndex=-1)
Insert or append path(s).

References _, SEARCH_STACK::AddPaths(), SEARCH_STACK::FindValidPath(), Format(), 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 352 of file symbol_lib_table.cpp.

353 {
354  SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
355 
356  if( !row || !row->plugin )
357  return nullptr;
358 
359  LIB_PART* part = row->plugin->LoadSymbol( row->GetFullURI( true ), aSymbolName,
360  row->GetProperties() );
361 
362  if( part == nullptr )
363  return part;
364 
365  // The library cannot know its own name, because it might have been renamed or moved.
366  // Therefore footprints cannot know their own library nickname when residing in
367  // a symbol library.
368  // Only at this API layer can we tell the symbol about its actual library nickname.
369  if( part )
370  {
371  LIB_ID id = part->GetLibId();
372 
373  id.SetLibNickname( row->GetNickName() );
374  part->SetLibId( id );
375  }
376 
377  return part;
378 }
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
LIB_ID GetLibId() const override
Definition: lib_symbol.h:131
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.
Definition: lib_symbol.h:93
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).
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
void SetLibId(const LIB_ID &aLibId)
Definition: lib_symbol.h:132

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(), SYMBOL_LIBRARY_MANAGER::GetAlias(), SYMBOL_LIBRARY_MANAGER::GetBufferedPart(), SYMBOL_LIBRARY_MANAGER::getOriginalParts(), SCH_EAGLE_PLUGIN::loadInstance(), LoadSymbol(), LoadSymbolWithOptionalNickname(), SYMBOL_LIBRARY_MANAGER::PartExists(), SYMBOL_LIBRARY_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 182 of file symbol_lib_table.h.

183  {
184  return LoadSymbol( aLibId.GetLibNickname(), aLibId.GetLibItemName() );
185  }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:106
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:92

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 320 of file symbol_lib_table.cpp.

322 {
323  SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
324  wxCHECK( row && row->plugin, /* void */ );
325 
326  wxString options = row->GetOptions();
327 
328  if( aPowerSymbolsOnly )
329  row->SetOptions( row->GetOptions() + " " + PropPowerSymsOnly );
330 
331  row->SetLoaded( false );
332  row->plugin->EnumerateSymbolLib( aSymbolList, row->GetFullURI( true ), row->GetProperties() );
333  row->SetLoaded( true );
334 
335  if( aPowerSymbolsOnly )
336  row->SetOptions( options );
337 
338  // The library cannot know its own name, because it might have been renamed or moved.
339  // Therefore footprints cannot know their own library nickname when residing in
340  // a symbol library.
341  // Only at this API layer can we tell the symbol about its actual library nickname.
342  for( LIB_PART* part : aSymbolList )
343  {
344  LIB_ID id = part->GetLibId();
345 
346  id.SetLibNickname( row->GetNickName() );
347  part->SetLibId( id );
348  }
349 }
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...
void SetLoaded(bool aLoaded)
Mark the row as being a loaded library.
const wxString & GetNickName() const
Define a library symbol object.
Definition: lib_symbol.h:93
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).
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
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(), LIB_TABLE_ROW::SetLoaded(), and LIB_TABLE_ROW::SetOptions().

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), and SYMBOL_LIBRARY_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 458 of file symbol_lib_table.cpp.

459 {
460  wxString nickname = aLibId.GetLibNickname();
461  wxString name = aLibId.GetLibItemName();
462 
463  if( nickname.size() )
464  {
465  return LoadSymbol( nickname, name );
466  }
467 
468  // nickname is empty, sequentially search (alphabetically) all libs/nicks for first match:
469  else
470  {
471  std::vector<wxString> nicks = GetLogicalLibs();
472 
473  // Search each library going through libraries alphabetically.
474  for( unsigned i = 0; i < nicks.size(); ++i )
475  {
476  // FootprintLoad() returns NULL on not found, does not throw exception
477  // unless there's an IO_ERROR.
478  LIB_PART* ret = LoadSymbol( nicks[i], name );
479 
480  if( ret )
481  return ret;
482  }
483 
484  return nullptr;
485  }
486 }
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.
Definition: lib_symbol.h:93
const char * name
Definition: DXF_plotter.cpp:59
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 347 of file lib_table_base.h.

347 { 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 331 of file lib_table_base.h.

332  {
333  if( rows.size() == r.rows.size() )
334  {
335  unsigned i;
336 
337  for( i = 0; i < rows.size() && rows[i] == r.rows[i]; ++i )
338  ;
339 
340  if( i == rows.size() )
341  return true;
342  }
343 
344  return false;
345  }
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 102 of file symbol_lib_table.cpp.

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

References _, Format(), 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 346 of file lib_table_base.cpp.

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

References name, and OPT_SEP.

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

◆ reindex()

void LIB_TABLE::reindex ( )
inlineprotectedinherited

Definition at line 502 of file lib_table_base.h.

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

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

References LIB_TABLE::rows.

Referenced by SYMBOL_LIBRARY_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 339 of file lib_table_base.cpp.

340 {
341  FILE_OUTPUTFORMATTER sf( aFileName );
342  Format( &sf, 0 );
343 }
virtual void Format(OUTPUTFORMATTER *aOutput, int aIndentLevel) const =0
Generate the table in s-expression format to aOutput with an indention level of aIndentLevel.
Used for text file output.
Definition: richio.h:453

References LIB_TABLE::Format().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), FP_LIB_TABLE::LoadGlobalTable(), LoadGlobalTable(), PCB_EDIT_FRAME::OpenProjectFiles(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH::IFACE::SaveFileAs(), SCH_BASE_FRAME::saveSymbolLibTables(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow(), and DIALOG_GLOBAL_SYM_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 381 of file symbol_lib_table.cpp.

383 {
384  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
385  wxCHECK( row && row->plugin, SAVE_SKIPPED );
386 
387  if( !row->plugin->IsSymbolLibWritable( row->GetFullURI( true ) ) )
388  return SAVE_SKIPPED;
389 
390  if( !aOverwrite )
391  {
392  // Try loading the footprint to see if it already exists, caller wants overwrite
393  // protection, which is atypical, not the default.
394 
395  wxString name = aSymbol->GetLibId().GetLibItemName();
396 
397  std::unique_ptr< LIB_PART > symbol( row->plugin->LoadSymbol( row->GetFullURI( true ),
398  name,
399  row->GetProperties() ) );
400 
401  if( symbol.get() )
402  return SAVE_SKIPPED;
403  }
404 
405  try
406  {
407  row->plugin->SaveSymbol( row->GetFullURI( true ), aSymbol, row->GetProperties() );
408  }
409  catch( const IO_ERROR& )
410  {
411  return SAVE_SKIPPED;
412  }
413 
414  return SAVE_OK;
415 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:106
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
LIB_ID GetLibId() const override
Definition: lib_symbol.h:131
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:59
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).
SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName, bool aCheckIfEnabled=false)
Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table f...
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75

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 SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer().

◆ Type()

KICAD_T SYMBOL_LIB_TABLE::Type ( )
inlineoverridevirtual

Implements PROJECT::_ELEM.

Definition at line 117 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 112 of file symbol_lib_table.h.

◆ SYMBOL_LIB_TABLE_GRID

friend class SYMBOL_LIB_TABLE_GRID
friend

Definition at line 111 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 114 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 533 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 120 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: