KiCad PCB EDA Suite
SYMBOL_LIB_TABLE_GRID Class Reference

Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object. More...

Inheritance diagram for SYMBOL_LIB_TABLE_GRID:
LIB_TABLE_GRID SYMBOL_LIB_TABLE LIB_TABLE PROJECT::_ELEM

Public Types

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

Public Member Functions

void SetValue (int aRow, int aCol, const wxString &aValue) override
 
 SYMBOL_LIB_TABLE_GRID (const SYMBOL_LIB_TABLE &aTableToEdit)
 
int GetNumberRows () override
 
int GetNumberCols () override
 
wxString GetValue (int aRow, int aCol) override
 
bool GetValueAsBool (int aRow, int aCol) override
 
void SetValueAsBool (int aRow, int aCol, bool aValue) override
 
bool IsEmptyCell (int aRow, int aCol) override
 
bool InsertRows (size_t aPos=0, size_t aNumRows=1) override
 
bool AppendRows (size_t aNumRows=1) override
 
bool DeleteRows (size_t aPos, size_t aNumRows) override
 
wxString GetColLabelValue (int aCol) override
 
bool ContainsNickname (const wxString &aNickname)
 
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 indentation level of aIndentLevel. 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_SYMBOL * > &aAliasList, const wxString &aNickname, bool aPowerSymbolsOnly=false)
 
LIB_SYMBOLLoadSymbol (const wxString &aNickname, const wxString &aName)
 Load a LIB_SYMBOL having aName from the library given by aNickname. More...
 
LIB_SYMBOLLoadSymbol (const LIB_ID &aLibId)
 
SAVE_T SaveSymbol (const wxString &aNickname, const LIB_SYMBOL *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_SYMBOLLoadSymbolWithOptionalNickname (const LIB_ID &aId)
 Load a LIB_SYMBOL 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_ROWat (size_t aIndex) override
 
size_t size () const override
 
LIB_TABLE_ROWmakeNewRow () override
 
LIB_TABLE_ROWS_ITER begin () override
 
LIB_TABLE_ROWS_ITER insert (LIB_TABLE_ROWS_ITER aIterator, LIB_TABLE_ROW *aRow) override
 
void push_back (LIB_TABLE_ROW *aRow) override
 
LIB_TABLE_ROWS_ITER erase (LIB_TABLE_ROWS_ITER aFirst, LIB_TABLE_ROWS_ITER aLast) override
 
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
 
std::recursive_mutex m_nickIndexMutex
 Mutex to protect access to the nickIndex variable. More...
 

Friends

class SYMBOL_GRID_TRICKS
 

Detailed Description

Build a wxGridTableBase by wrapping an SYMBOL_LIB_TABLE object.

Definition at line 80 of file panel_sym_lib_table.cpp.

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

◆ INDEX_CITER

typedef INDEX::const_iterator LIB_TABLE::INDEX_CITER
protectedinherited

Definition at line 536 of file lib_table_base.h.

◆ INDEX_ITER

typedef INDEX::iterator LIB_TABLE::INDEX_ITER
protectedinherited

Definition at line 535 of file lib_table_base.h.

◆ INDEX_VALUE

typedef INDEX::value_type LIB_TABLE::INDEX_VALUE
protectedinherited

Definition at line 537 of file lib_table_base.h.

Member Enumeration Documentation

◆ SAVE_T

enum SYMBOL_LIB_TABLE::SAVE_T
inherited

The set of return values from SaveSymbol() below.

Enumerator
SAVE_OK 
SAVE_SKIPPED 

Definition at line 182 of file symbol_lib_table.h.

Constructor & Destructor Documentation

◆ SYMBOL_LIB_TABLE_GRID()

SYMBOL_LIB_TABLE_GRID::SYMBOL_LIB_TABLE_GRID ( const SYMBOL_LIB_TABLE aTableToEdit)
inline

Definition at line 130 of file panel_sym_lib_table.cpp.

131  {
132  rows = aTableToEdit.rows;
133  }
LIB_TABLE_ROWS rows

References LIB_TABLE::rows.

Member Function Documentation

◆ AppendRows()

bool LIB_TABLE_GRID::AppendRows ( size_t  aNumRows = 1)
inlineoverrideinherited

Definition at line 141 of file lib_table_grid.h.

142  {
143  // do not modify aNumRows, original value needed for wxGridTableMessage below
144  for( int i = aNumRows; i; --i )
145  push_back( makeNewRow() );
146 
147  if( GetView() )
148  {
149  wxGridTableMessage msg( this, wxGRIDTABLE_NOTIFY_ROWS_APPENDED, aNumRows );
150  GetView()->ProcessTableMessage( msg );
151  }
152 
153  return true;
154  }
virtual LIB_TABLE_ROW * makeNewRow()=0
virtual void push_back(LIB_TABLE_ROW *aRow)=0

References LIB_TABLE_GRID::makeNewRow(), and LIB_TABLE_GRID::push_back().

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

◆ at()

LIB_TABLE_ROW* SYMBOL_LIB_TABLE_GRID::at ( size_t  aIndex)
inlineoverrideprotectedvirtual

Implements LIB_TABLE_GRID.

Definition at line 85 of file panel_sym_lib_table.cpp.

85 { return &rows.at( aIndex ); }
LIB_TABLE_ROWS rows

References LIB_TABLE::rows.

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

366  {
367  return rows[aIndex];
368  }
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 373 of file lib_table_base.h.

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

References LIB_TABLE::rows.

◆ begin()

LIB_TABLE_ROWS_ITER SYMBOL_LIB_TABLE_GRID::begin ( )
inlineoverrideprotectedvirtual

Implements LIB_TABLE_GRID.

Definition at line 94 of file panel_sym_lib_table.cpp.

94 { return rows.begin(); }
LIB_TABLE_ROWS rows

References LIB_TABLE::rows.

◆ Clear()

void LIB_TABLE::Clear ( )
inlineinherited

Delete all rows.

Definition at line 320 of file lib_table_base.h.

321  {
322  std::lock_guard<std::recursive_mutex> lock( m_nickIndexMutex );
323 
324  rows.clear();
325  nickIndex.clear();
326  }
LIB_TABLE_ROWS rows
std::recursive_mutex m_nickIndexMutex
Mutex to protect access to the nickIndex variable.
INDEX nickIndex
this particular key is the nickName within each row.

References LIB_TABLE::m_nickIndexMutex, LIB_TABLE::nickIndex, and LIB_TABLE::rows.

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

◆ ContainsNickname()

bool LIB_TABLE_GRID::ContainsNickname ( const wxString &  aNickname)
inlineinherited

Definition at line 192 of file lib_table_grid.h.

193  {
194  for( size_t i = 0; i < size(); ++i )
195  {
196  LIB_TABLE_ROW* row = at( i );
197 
198  if( row->GetNickName() == aNickname )
199  return true;
200  }
201  return false;
202  }
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
virtual LIB_TABLE_ROW * at(size_t aIndex)=0
const wxString & GetNickName() const
virtual size_t size() const =0

References LIB_TABLE_GRID::at(), LIB_TABLE_ROW::GetNickName(), and LIB_TABLE_GRID::size().

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

◆ CreateSymbolLib()

void SYMBOL_LIB_TABLE::CreateSymbolLib ( const wxString &  aNickname)
inherited

Definition at line 446 of file symbol_lib_table.cpp.

447 {
448  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
449  wxCHECK( row && row->plugin, /* void */ );
450  row->plugin->CreateSymbolLib( row->GetFullURI( true ), row->GetProperties() );
451 }
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 SYMBOL_LIB_TABLE::FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetProperties(), and SYMBOL_LIB_TABLE_ROW::plugin.

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary().

◆ DeleteRows()

bool LIB_TABLE_GRID::DeleteRows ( size_t  aPos,
size_t  aNumRows 
)
inlineoverrideinherited

Definition at line 156 of file lib_table_grid.h.

157  {
158  // aPos may be a large positive, e.g. size_t(-1), and the sum of
159  // aPos+aNumRows may wrap here, so both ends of the range are tested.
160  if( aPos < size() && aPos + aNumRows <= size() )
161  {
162  LIB_TABLE_ROWS_ITER start = begin() + aPos;
163  erase( start, start + aNumRows );
164  if( GetView() )
165  {
166  wxGridTableMessage msg( this, wxGRIDTABLE_NOTIFY_ROWS_DELETED, aPos, aNumRows );
167  GetView()->ProcessTableMessage( msg );
168  }
169  return true;
170  }
171 
172  return false;
173  }
virtual LIB_TABLE_ROWS_ITER begin()=0
virtual size_t size() const =0
LIB_TABLE_ROWS::iterator LIB_TABLE_ROWS_ITER
virtual LIB_TABLE_ROWS_ITER erase(LIB_TABLE_ROWS_ITER aFirst, LIB_TABLE_ROWS_ITER aLast)=0

References LIB_TABLE_GRID::begin(), LIB_TABLE_GRID::erase(), and LIB_TABLE_GRID::size().

◆ DeleteSymbol()

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

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

416 {
417  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
418  wxCHECK( row && row->plugin, /* void */ );
419  return row->plugin->DeleteSymbol( row->GetFullURI( true ), aSymbolName, row->GetProperties() );
420 }
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 SYMBOL_LIB_TABLE::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)
inherited

Definition at line 438 of file symbol_lib_table.cpp.

439 {
440  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
441  wxCHECK( row && row->plugin, /* void */ );
442  row->plugin->DeleteSymbolLib( row->GetFullURI( true ), row->GetProperties() );
443 }
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 SYMBOL_LIB_TABLE::FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetProperties(), and SYMBOL_LIB_TABLE_ROW::plugin.

◆ ensureIndex()

void LIB_TABLE::ensureIndex ( )
inlineprotectedinherited

Definition at line 515 of file lib_table_base.h.

516  {
517  std::lock_guard<std::recursive_mutex> lock( m_nickIndexMutex );
518 
519  // The dialog lib table editor may not maintain the nickIndex.
520  // Lazy indexing may be required. To handle lazy indexing, we must enforce
521  // that "nickIndex" is either empty or accurate, but never inaccurate.
522  if( !nickIndex.size() )
523  reindex();
524  }
void reindex()
std::recursive_mutex m_nickIndexMutex
Mutex to protect access to the nickIndex variable.
INDEX nickIndex
this particular key is the nickName within each row.

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

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

285 {
286  SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
287  wxCHECK( row && row->plugin, /* void */ );
288 
289  wxString options = row->GetOptions();
290 
291  if( aPowerSymbolsOnly )
292  row->SetOptions( row->GetOptions() + " " + PropPowerSymsOnly );
293 
294  row->SetLoaded( false );
295  row->plugin->EnumerateSymbolLib( aAliasNames, row->GetFullURI( true ), row->GetProperties() );
296  row->SetLoaded( true );
297 
298  if( aPowerSymbolsOnly )
299  row->SetOptions( options );
300 }
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 SYMBOL_LIB_TABLE::FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetOptions(), LIB_TABLE_ROW::GetProperties(), SYMBOL_LIB_TABLE_ROW::plugin, SYMBOL_LIB_TABLE::PropPowerSymsOnly, LIB_TABLE_ROW::SetLoaded(), and LIB_TABLE_ROW::SetOptions().

Referenced by SYMBOL_LIBRARY_MANAGER::getOriginalSymbols().

◆ erase()

LIB_TABLE_ROWS_ITER SYMBOL_LIB_TABLE_GRID::erase ( LIB_TABLE_ROWS_ITER  aFirst,
LIB_TABLE_ROWS_ITER  aLast 
)
inlineoverrideprotectedvirtual

Implements LIB_TABLE_GRID.

Definition at line 103 of file panel_sym_lib_table.cpp.

104  {
105  return rows.erase( aFirst, aLast );
106  }
LIB_TABLE_ROWS rows

References LIB_TABLE::rows.

◆ FindRow()

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

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

304 {
305  SYMBOL_LIB_TABLE_ROW* row =
306  dynamic_cast< SYMBOL_LIB_TABLE_ROW* >( findRow( aNickname, aCheckIfEnabled ) );
307 
308  if( !row )
309  return nullptr;
310 
311  // We've been 'lazy' up until now, but it cannot be deferred any longer,
312  // instantiate a PLUGIN of the proper kind if it is not already in this
313  // SYMBOL_LIB_TABLE_ROW.
314  if( !row->plugin )
315  row->setPlugin( SCH_IO_MGR::FindPlugin( row->type ) );
316 
317  return row;
318 }
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 SYMBOL_LIB_TABLE::CreateSymbolLib(), SYMBOL_LIB_TABLE::DeleteSymbol(), SYMBOL_LIB_TABLE::DeleteSymbolLib(), SYMBOL_LIB_TABLE::EnumerateSymbolLib(), SYMBOL_LIBRARY_MANAGER::GetLibrary(), SYMBOL_LIB_TABLE::GetModifyHash(), SYMBOL_LIB_TABLE::IsSymbolLibLoaded(), SYMBOL_LIB_TABLE::IsSymbolLibWritable(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIB_TABLE::LoadSymbolLib(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SYMBOL_LIB_TABLE::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  std::lock_guard<std::recursive_mutex> lock( m_nickIndexMutex );
189 
190  do
191  {
192  cur->ensureIndex();
193 
194  for( const std::pair<const wxString, int>& entry : cur->nickIndex )
195  {
196  if( entry.first == aNickName )
197  {
198  row = &cur->rows[entry.second];
199 
200  if( !aCheckIfEnabled || ( aCheckIfEnabled && row->GetIsEnabled() ) )
201  return row;
202  }
203  }
204 
205  // Repeat, this time looking for names that were "fixed" by legacy versions because
206  // the old eeschema file format didn't support spaces in tokens.
207  for( const std::pair<const wxString, int>& entry : cur->nickIndex )
208  {
209  wxString legacyLibName = entry.first;
210  legacyLibName.Replace( " ", "_" );
211 
212  if( legacyLibName == aNickName )
213  {
214  row = &cur->rows[entry.second];
215 
216  if( !aCheckIfEnabled || ( aCheckIfEnabled && row->GetIsEnabled() ) )
217  return row;
218  }
219  }
220 
221  // not found, search fall back table(s), if any
222  } while( ( cur = cur->fallBack ) != nullptr );
223 
224  return nullptr; // not found
225 }
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
std::recursive_mutex m_nickIndexMutex
Mutex to protect access to the nickIndex variable.
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::m_nickIndexMutex, LIB_TABLE::nickIndex, and LIB_TABLE::rows.

Referenced by FP_LIB_TABLE::FindRow(), SYMBOL_LIB_TABLE::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 228 of file lib_table_base.cpp.

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

◆ Format()

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

Generate the table in s-expression format to aOutput with an indentation 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 246 of file symbol_lib_table.cpp.

247 {
248  aOutput->Print( aIndentLevel, "(sym_lib_table\n" );
249 
250  for( LIB_TABLE_ROWS_CITER it = rows.begin(); it != rows.end(); ++it )
251  {
252  it->Format( aOutput, aIndentLevel+1 );
253  }
254 
255  aOutput->Print( aIndentLevel, ")\n" );
256 }
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:426

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

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

◆ GetColLabelValue()

wxString LIB_TABLE_GRID::GetColLabelValue ( int  aCol)
inlineoverrideinherited

Definition at line 175 of file lib_table_grid.h.

176  {
177  switch( aCol )
178  {
179  case COL_NICKNAME: return _( "Nickname" );
180  case COL_URI: return _( "Library Path" );
181 
182  // keep this "Library Format" text fairly long so column is sized wide enough
183  case COL_TYPE: return _( "Library Format" );
184  case COL_OPTIONS: return _( "Options" );
185  case COL_DESCR: return _( "Description" );
186  case COL_ENABLED: return _( "Active" );
187 
188  default: return wxEmptyString;
189  }
190  }
#define _(s)

References _, COL_DESCR, COL_ENABLED, COL_NICKNAME, COL_OPTIONS, COL_TYPE, and COL_URI.

◆ GetCount()

unsigned LIB_TABLE::GetCount ( ) const
inlineinherited

Get the number of rows contained in the table.

Definition at line 355 of file lib_table_base.h.

356  {
357  return rows.size();
358  }
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::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::saveSymbolAs(), 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 ( )
staticinherited

Fetch the global symbol library table file name.

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

Definition at line 534 of file symbol_lib_table.cpp.

535 {
536  wxFileName fn;
537 
539  fn.SetName( global_tbl_name );
540 
541  return fn.GetFullPath();
542 }
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(), SYMBOL_LIB_TABLE::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 264 of file lib_table_base.cpp.

265 {
266  // Only return unique logical library names. Use std::set::insert() to
267  // quietly reject any duplicates, which can happen when encountering a duplicate
268  // nickname from one of the fall back table(s).
269 
270  std::set< wxString > unique;
271  std::vector< wxString > ret;
272  const LIB_TABLE* cur = this;
273 
274  do
275  {
276  for( LIB_TABLE_ROWS_CITER it = cur->rows.begin(); it!=cur->rows.end(); ++it )
277  {
278  if( it->GetIsEnabled() )
279  {
280  unique.insert( it->GetNickName() );
281  }
282  }
283 
284  } while( ( cur = cur->fallBack ) != nullptr );
285 
286  ret.reserve( unique.size() );
287 
288  // return a sorted, unique set of nicknames in a std::vector<wxString> to caller
289  for( std::set< wxString >::const_iterator it = unique.begin(); it!=unique.end(); ++it )
290  {
291  ret.push_back( *it );
292  }
293 
294  // We want to allow case-sensitive duplicates but sort by case-insensitive ordering
295  std::sort( ret.begin(), ret.end(),
296  []( const wxString& lhs, const wxString& rhs )
297  {
298  return lhs.CmpNoCase( rhs ) < 0;
299  } );
300 
301  return ret;
302 }
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::BuildLibrariesListBox(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), FP_LIB_TABLE::GenerateTimestamp(), GetFootprintLibraries(), SYMBOL_LIBRARY_MANAGER::GetLibraryCount(), SYMBOL_LIB_TABLE::GetModifyHash(), guessNickname(), CVPCB_MAINFRAME::LoadFootprintFiles(), SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname(), FOOTPRINT_VIEWER_FRAME::OnActivate(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_BASE_FRAME::PickSymbolFromLibTree(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::saveSymbolAs(), PCB_BASE_FRAME::SelectLibrary(), FOOTPRINT_LIST_IMPL::startWorkers(), and FP_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ GetModifyHash()

int SYMBOL_LIB_TABLE::GetModifyHash ( )
inherited

Definition at line 259 of file symbol_lib_table.cpp.

260 {
261  int hash = 0;
262  std::vector< wxString > libNames = GetLogicalLibs();
263 
264  for( const auto& libName : libNames )
265  {
266  const SYMBOL_LIB_TABLE_ROW* row = FindRow( libName, true );
267 
268  if( !row || !row->plugin )
269  {
270  wxFAIL;
271  continue;
272  }
273 
274  hash += row->plugin->GetModifyHash();
275  }
276 
277  hash += m_modifyHash;
278 
279  return hash;
280 }
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 SYMBOL_LIB_TABLE::FindRow(), LIB_TABLE::GetLogicalLibs(), SYMBOL_LIB_TABLE::m_modifyHash, and SYMBOL_LIB_TABLE_ROW::plugin.

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

◆ GetNumberCols()

int LIB_TABLE_GRID::GetNumberCols ( )
inlineoverrideinherited

Definition at line 55 of file lib_table_grid.h.

55 { return COL_COUNT; }

References COL_COUNT.

◆ GetNumberRows()

int LIB_TABLE_GRID::GetNumberRows ( )
inlineoverrideinherited

Definition at line 53 of file lib_table_grid.h.

53 { return (int) size(); }
virtual size_t size() const =0

References LIB_TABLE_GRID::size().

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

◆ GetSymbolLibTableFileName()

◆ GetValue()

wxString LIB_TABLE_GRID::GetValue ( int  aRow,
int  aCol 
)
inlineoverrideinherited

Definition at line 57 of file lib_table_grid.h.

58  {
59  if( aRow < (int) size() )
60  {
61  const LIB_TABLE_ROW* r = at( (size_t) aRow );
62 
63  switch( aCol )
64  {
65  case COL_NICKNAME: return UnescapeString( r->GetNickName() );
66  case COL_URI: return r->GetFullURI();
67  case COL_TYPE: return r->GetType();
68  case COL_OPTIONS: return r->GetOptions();
69  case COL_DESCR: return r->GetDescr();
70  case COL_ENABLED: return r->GetIsEnabled() ? wxT( "1" ) : wxT( "0" );
71  default: return wxEmptyString;
72  }
73  }
74 
75  return wxEmptyString;
76  }
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
virtual LIB_TABLE_ROW * at(size_t aIndex)=0
E_SERIE r
Definition: eserie.cpp:41
wxString UnescapeString(const wxString &aSource)
virtual size_t size() const =0

References LIB_TABLE_GRID::at(), COL_DESCR, COL_ENABLED, COL_NICKNAME, COL_OPTIONS, COL_TYPE, COL_URI, r, LIB_TABLE_GRID::size(), and UnescapeString().

Referenced by LIB_TABLE_GRID::IsEmptyCell().

◆ GetValueAsBool()

bool LIB_TABLE_GRID::GetValueAsBool ( int  aRow,
int  aCol 
)
inlineoverrideinherited

Definition at line 78 of file lib_table_grid.h.

79  {
80  if( aRow < (int) size() && aCol == COL_ENABLED )
81  return at( (size_t) aRow )->GetIsEnabled();
82  else
83  return false;
84  }
virtual LIB_TABLE_ROW * at(size_t aIndex)=0
bool GetIsEnabled() const
virtual size_t size() const =0

References LIB_TABLE_GRID::at(), COL_ENABLED, LIB_TABLE_ROW::GetIsEnabled(), and LIB_TABLE_GRID::size().

◆ GlobalPathEnvVariableName()

const wxString SYMBOL_LIB_TABLE::GlobalPathEnvVariableName ( )
staticinherited

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

485 {
486  return "KICAD6_SYMBOL_DIR";
487 }

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

◆ insert()

LIB_TABLE_ROWS_ITER SYMBOL_LIB_TABLE_GRID::insert ( LIB_TABLE_ROWS_ITER  aIterator,
LIB_TABLE_ROW aRow 
)
inlineoverrideprotectedvirtual

Implements LIB_TABLE_GRID.

Definition at line 96 of file panel_sym_lib_table.cpp.

97  {
98  return rows.insert( aIterator, aRow );
99  }
LIB_TABLE_ROWS rows

References LIB_TABLE::rows.

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

306 {
307  std::lock_guard<std::recursive_mutex> lock( m_nickIndexMutex );
308 
309  ensureIndex();
310 
311  INDEX_CITER it = nickIndex.find( aRow->GetNickName() );
312 
313  if( it == nickIndex.end() )
314  {
315  rows.push_back( aRow );
316  nickIndex.insert( INDEX_VALUE( aRow->GetNickName(), rows.size() - 1 ) );
317  return true;
318  }
319 
320  if( doReplace )
321  {
322  rows.replace( it->second, aRow );
323  return true;
324  }
325 
326  return false;
327 }
void ensureIndex()
INDEX::const_iterator INDEX_CITER
LIB_TABLE_ROWS rows
INDEX::value_type INDEX_VALUE
const wxString & GetNickName() const
std::recursive_mutex m_nickIndexMutex
Mutex to protect access to the nickIndex variable.
INDEX nickIndex
this particular key is the nickName within each row.

References LIB_TABLE::ensureIndex(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE::m_nickIndexMutex, 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 SYMBOL_LIB_TABLE::Parse().

◆ InsertRows()

bool LIB_TABLE_GRID::InsertRows ( size_t  aPos = 0,
size_t  aNumRows = 1 
)
inlineoverrideinherited

Definition at line 115 of file lib_table_grid.h.

116  {
117  if( aPos < size() )
118  {
119  for( size_t i = 0; i < aNumRows; i++ )
120  {
121  insert( begin() + i, makeNewRow() );
122  }
123 
124  // use the (wxGridStringTable) source Luke.
125  if( GetView() )
126  {
127  wxGridTableMessage msg( this,
128  wxGRIDTABLE_NOTIFY_ROWS_INSERTED,
129  aPos,
130  aNumRows );
131 
132  GetView()->ProcessTableMessage( msg );
133  }
134 
135  return true;
136  }
137 
138  return false;
139  }
virtual LIB_TABLE_ROWS_ITER insert(LIB_TABLE_ROWS_ITER aIterator, LIB_TABLE_ROW *aRow)=0
virtual LIB_TABLE_ROW * makeNewRow()=0
virtual LIB_TABLE_ROWS_ITER begin()=0
virtual size_t size() const =0

References LIB_TABLE_GRID::begin(), LIB_TABLE_GRID::insert(), LIB_TABLE_GRID::makeNewRow(), and LIB_TABLE_GRID::size().

◆ 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().

◆ IsEmptyCell()

bool LIB_TABLE_GRID::IsEmptyCell ( int  aRow,
int  aCol 
)
inlineoverrideinherited

Definition at line 110 of file lib_table_grid.h.

111  {
112  return !GetValue( aRow, aCol );
113  }
wxString GetValue(int aRow, int aCol) override

References LIB_TABLE_GRID::GetValue().

◆ IsSymbolLibLoaded()

bool SYMBOL_LIB_TABLE::IsSymbolLibLoaded ( const wxString &  aNickname)
inherited

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

431 {
432  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
433  wxCHECK( row, false );
434  return row->GetIsLoaded();
435 }
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 SYMBOL_LIB_TABLE::FindRow(), and LIB_TABLE_ROW::GetIsLoaded().

Referenced by SYMBOL_LIBRARY_MANAGER::IsLibraryLoaded().

◆ IsSymbolLibWritable()

bool SYMBOL_LIB_TABLE::IsSymbolLibWritable ( const wxString &  aNickname)
inherited

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

424 {
425  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
426  wxCHECK( row && row->plugin, false );
427  return row->plugin->IsSymbolLibWritable( row->GetFullURI( true ) );
428 }
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 SYMBOL_LIB_TABLE::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 330 of file lib_table_base.cpp.

332 {
333  // It's OK if footprint library tables are missing.
334  if( wxFileName::IsFileReadable( aFileName ) )
335  {
336  FILE_LINE_READER reader( aFileName );
337  LIB_TABLE_LEXER lexer( &reader );
338 
339  Parse( &lexer );
340  }
341 }
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 SYMBOL_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), SCH_EDIT_FRAME::LoadSheetFromFile(), PROJECT::PcbFootprintLibs(), SCH::IFACE::SaveFileAs(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow(), and DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow().

◆ LoadGlobalTable()

bool SYMBOL_LIB_TABLE::LoadGlobalTable ( SYMBOL_LIB_TABLE aTable)
staticinherited

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

491 {
492  bool tableExists = true;
493  wxFileName fn = GetGlobalTableFileName();
494 
495  if( !fn.FileExists() )
496  {
497  tableExists = false;
498 
499  if( !fn.DirExists() && !fn.Mkdir( 0x777, wxPATH_MKDIR_FULL ) )
500  {
501  THROW_IO_ERROR( wxString::Format( _( "Cannot create global library table path '%s'." ),
502  fn.GetPath() ) );
503  }
504 
505  // Attempt to copy the default global file table from the KiCad
506  // template folder to the user's home configuration path.
507  SEARCH_STACK ss;
508 
509  SystemDirsAppend( &ss );
510 
511  wxString templatePath =
512  Pgm().GetLocalEnvVariables().at( wxT( "KICAD6_TEMPLATE_DIR" ) ).GetValue();
513 
514  if( !templatePath.IsEmpty() )
515  ss.AddPaths( templatePath, 0 );
516 
517  wxString fileName = ss.FindValidPath( global_tbl_name );
518 
519  // The fallback is to create an empty global symbol table for the user to populate.
520  if( fileName.IsEmpty() || !::wxCopyFile( fileName, fn.GetFullPath(), false ) )
521  {
522  SYMBOL_LIB_TABLE emptyTable;
523 
524  emptyTable.Save( fn.GetFullPath() );
525  }
526  }
527 
528  aTable.Load( fn.GetFullPath() );
529 
530  return tableExists;
531 }
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
#define _(s)
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
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(), SYMBOL_LIB_TABLE::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_SYMBOL * SYMBOL_LIB_TABLE::LoadSymbol ( const wxString &  aNickname,
const wxString &  aName 
)
inherited

Load a LIB_SYMBOL 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_SYMBOL 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 353 of file symbol_lib_table.cpp.

354 {
355  SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
356 
357  if( !row || !row->plugin )
358  return nullptr;
359 
360  LIB_SYMBOL* symbol = row->plugin->LoadSymbol( row->GetFullURI( true ), aSymbolName,
361  row->GetProperties() );
362 
363  // The library cannot know its own name, because it might have been renamed or moved.
364  // Therefore footprints cannot know their own library nickname when residing in
365  // a symbol library.
366  // Only at this API layer can we tell the symbol about its actual library nickname.
367  if( symbol )
368  {
369  LIB_ID id = symbol->GetLibId();
370 
371  id.SetLibNickname( row->GetNickName() );
372  symbol->SetLibId( id );
373  }
374 
375  return symbol;
376 }
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...
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
Define a library symbol object.
Definition: lib_symbol.h:96
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
LIB_ID GetLibId() const override
Definition: lib_symbol.h:135
void SetLibId(const LIB_ID &aLibId)
Definition: lib_symbol.h:136
int SetLibNickname(const UTF8 &aNickname)
Override the logical library name portion of the LIB_ID to aNickname.
Definition: lib_id.cpp:97
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 SYMBOL_LIB_TABLE::FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_SYMBOL::GetLibId(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE_ROW::GetProperties(), SYMBOL_LIB_TABLE_ROW::plugin, LIB_SYMBOL::SetLibId(), and LIB_ID::SetLibNickname().

Referenced by FOOTPRINT_INFO_GENERATOR::GenerateHtml(), SYMBOL_LIBRARY_MANAGER::GetAlias(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), SYMBOL_LIBRARY_MANAGER::getOriginalSymbols(), SCH_EAGLE_PLUGIN::loadInstance(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname(), SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer(), SchGetLibSymbol(), SYMBOL_LIBRARY_MANAGER::SymbolExists(), and SCH_SCREEN::UpdateSymbolLinks().

◆ LoadSymbol() [2/2]

LIB_SYMBOL* SYMBOL_LIB_TABLE::LoadSymbol ( const LIB_ID aLibId)
inlineinherited

Definition at line 174 of file symbol_lib_table.h.

175  {
176  return LoadSymbol( aLibId.GetLibNickname(), aLibId.GetLibItemName() );
177  }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:104
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:90
LIB_SYMBOL * LoadSymbol(const wxString &aNickname, const wxString &aName)
Load a LIB_SYMBOL having aName from the library given by aNickname.

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

◆ LoadSymbolLib()

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

Definition at line 321 of file symbol_lib_table.cpp.

323 {
324  SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
325  wxCHECK( row && row->plugin, /* void */ );
326 
327  wxString options = row->GetOptions();
328 
329  if( aPowerSymbolsOnly )
330  row->SetOptions( row->GetOptions() + " " + PropPowerSymsOnly );
331 
332  row->SetLoaded( false );
333  row->plugin->EnumerateSymbolLib( aSymbolList, row->GetFullURI( true ), row->GetProperties() );
334  row->SetLoaded( true );
335 
336  if( aPowerSymbolsOnly )
337  row->SetOptions( options );
338 
339  // The library cannot know its own name, because it might have been renamed or moved.
340  // Therefore footprints cannot know their own library nickname when residing in
341  // a symbol library.
342  // Only at this API layer can we tell the symbol about its actual library nickname.
343  for( LIB_SYMBOL* symbol : aSymbolList )
344  {
345  LIB_ID id = symbol->GetLibId();
346 
347  id.SetLibNickname( row->GetNickName() );
348  symbol->SetLibId( id );
349  }
350 }
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
Define a library symbol object.
Definition: lib_symbol.h:96
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
int SetLibNickname(const UTF8 &aNickname)
Override the logical library name portion of the LIB_ID to aNickname.
Definition: lib_id.cpp:97
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 SYMBOL_LIB_TABLE::FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE_ROW::GetOptions(), LIB_TABLE_ROW::GetProperties(), SYMBOL_LIB_TABLE_ROW::plugin, SYMBOL_LIB_TABLE::PropPowerSymsOnly, LIB_ID::SetLibNickname(), LIB_TABLE_ROW::SetLoaded(), and LIB_TABLE_ROW::SetOptions().

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), SYMBOL_LIBRARY_MANAGER::GetAliases(), and SYMBOL_ASYNC_LOADER::worker().

◆ LoadSymbolWithOptionalNickname()

LIB_SYMBOL * SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname ( const LIB_ID aId)
inherited

Load a LIB_SYMBOL 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 454 of file symbol_lib_table.cpp.

455 {
456  wxString nickname = aLibId.GetLibNickname();
457  wxString name = aLibId.GetLibItemName();
458 
459  if( nickname.size() )
460  {
461  return LoadSymbol( nickname, name );
462  }
463  else
464  {
465  // nickname is empty, sequentially search (alphabetically) all libs/nicks for first match:
466  std::vector<wxString> nicks = GetLogicalLibs();
467 
468  // Search each library going through libraries alphabetically.
469  for( unsigned i = 0; i < nicks.size(); ++i )
470  {
471  // FootprintLoad() returns NULL on not found, does not throw exception
472  // unless there's an IO_ERROR.
473  LIB_SYMBOL* ret = LoadSymbol( nicks[i], name );
474 
475  if( ret )
476  return ret;
477  }
478 
479  return nullptr;
480  }
481 }
Define a library symbol object.
Definition: lib_symbol.h:96
const char * name
Definition: DXF_plotter.cpp:56
LIB_SYMBOL * LoadSymbol(const wxString &aNickname, const wxString &aName)
Load a LIB_SYMBOL having aName from the library given by aNickname.
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(), SYMBOL_LIB_TABLE::LoadSymbol(), and name.

◆ makeNewRow()

LIB_TABLE_ROW* SYMBOL_LIB_TABLE_GRID::makeNewRow ( )
inlineoverrideprotectedvirtual

Implements LIB_TABLE_GRID.

Definition at line 89 of file panel_sym_lib_table.cpp.

90  {
91  return dynamic_cast< LIB_TABLE_ROW* >( new SYMBOL_LIB_TABLE_ROW );
92  }
Hold a record identifying a symbol library accessed by the appropriate symbol library SCH_PLUGIN obje...

◆ operator!=()

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

Definition at line 350 of file lib_table_base.h.

350 { return !( *this == r ); }
E_SERIE r
Definition: eserie.cpp:41

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

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

References r, and LIB_TABLE::rows.

◆ Parse()

void SYMBOL_LIB_TABLE::Parse ( LIB_TABLE_LEXER *  aLexer)
overridevirtualinherited

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

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

References name, and OPT_SEP.

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

◆ push_back()

void SYMBOL_LIB_TABLE_GRID::push_back ( LIB_TABLE_ROW aRow)
inlineoverrideprotectedvirtual

Implements LIB_TABLE_GRID.

Definition at line 101 of file panel_sym_lib_table.cpp.

101 { rows.push_back( aRow ); }
LIB_TABLE_ROWS rows

References LIB_TABLE::rows.

◆ reindex()

void LIB_TABLE::reindex ( )
inlineprotectedinherited

Definition at line 505 of file lib_table_base.h.

506  {
507  std::lock_guard<std::recursive_mutex> lock( m_nickIndexMutex );
508 
509  nickIndex.clear();
510 
511  for( LIB_TABLE_ROWS_ITER it = rows.begin(); it != rows.end(); ++it )
512  nickIndex.insert( INDEX_VALUE( it->GetNickName(), it - rows.begin() ) );
513  }
LIB_TABLE_ROWS rows
INDEX::value_type INDEX_VALUE
LIB_TABLE_ROWS::iterator LIB_TABLE_ROWS_ITER
std::recursive_mutex m_nickIndexMutex
Mutex to protect access to the nickIndex variable.
INDEX nickIndex
this particular key is the nickName within each row.

References LIB_TABLE::m_nickIndexMutex, 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 432 of file lib_table_base.h.

433  {
434  for( auto iter = rows.begin(); iter != rows.end(); ++iter )
435  {
436  if( *iter == *aRow )
437  {
438  rows.erase( iter, iter + 1 );
439  return true;
440  }
441  }
442  return false;
443  }
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 344 of file lib_table_base.cpp.

345 {
346  FILE_OUTPUTFORMATTER sf( aFileName );
347  Format( &sf, 0 );
348 }
virtual void Format(OUTPUTFORMATTER *aOutput, int aIndentLevel) const =0
Generate the table in s-expression format to aOutput with an indentation level of aIndentLevel.
Used for text file output.
Definition: richio.h:456

References LIB_TABLE::Format().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), SYMBOL_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::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_SYMBOL aSymbol,
bool  aOverwrite = true 
)
inherited

Write aSymbol to an existing library given by aNickname.

If a LIB_SYMBOL by the same name already exists or there are any conflicting alias names, the new LIB_SYMBOL will silently overwrite any existing aliases and/or part because 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 379 of file symbol_lib_table.cpp.

381 {
382  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
383  wxCHECK( row && row->plugin, SAVE_SKIPPED );
384 
385  if( !row->plugin->IsSymbolLibWritable( row->GetFullURI( true ) ) )
386  return SAVE_SKIPPED;
387 
388  if( !aOverwrite )
389  {
390  // Try loading the footprint to see if it already exists, caller wants overwrite
391  // protection, which is atypical, not the default.
392 
393  wxString name = aSymbol->GetLibId().GetLibItemName();
394 
395  std::unique_ptr<LIB_SYMBOL> symbol( row->plugin->LoadSymbol( row->GetFullURI( true ),
396  name, row->GetProperties() ) );
397 
398  if( symbol.get() )
399  return SAVE_SKIPPED;
400  }
401 
402  try
403  {
404  row->plugin->SaveSymbol( row->GetFullURI( true ), aSymbol, row->GetProperties() );
405  }
406  catch( const IO_ERROR& )
407  {
408  return SAVE_SKIPPED;
409  }
410 
411  return SAVE_OK;
412 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:104
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...
LIB_ID GetLibId() const override
Definition: lib_symbol.h:135
const char * name
Definition: DXF_plotter.cpp:56
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 SYMBOL_LIB_TABLE::FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_SYMBOL::GetLibId(), LIB_ID::GetLibItemName(), LIB_TABLE_ROW::GetProperties(), name, SYMBOL_LIB_TABLE_ROW::plugin, SYMBOL_LIB_TABLE::SAVE_OK, and SYMBOL_LIB_TABLE::SAVE_SKIPPED.

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

◆ SetValue()

void SYMBOL_LIB_TABLE_GRID::SetValue ( int  aRow,
int  aCol,
const wxString &  aValue 
)
inlineoverride

Definition at line 109 of file panel_sym_lib_table.cpp.

110  {
111  LIB_TABLE_GRID::SetValue( aRow, aCol, aValue );
112 
113  // If setting a filepath, attempt to auto-detect the format
114  if( aCol == COL_URI )
115  {
116  wxFileName fn( aValue );
117 
118  for( SCH_IO_MGR::SCH_FILE_T piType : SCH_IO_MGR::SCH_FILE_T_vector )
119  {
120  if( SCH_IO_MGR::GetLibraryFileExtension( piType ).Lower() == fn.GetExt().Lower() )
121  {
122  SetValue( aRow, COL_TYPE, SCH_IO_MGR::ShowType( piType ) );
123  break;
124  }
125  }
126  }
127  }
static const wxString ShowType(SCH_FILE_T aFileType)
Return a brief name for a plugin, given aFileType enum.
Definition: sch_io_mgr.cpp:79
static const wxString GetLibraryFileExtension(SCH_FILE_T aFileType)
Return the symbol library file extension (if any) for aFileType.
Definition: sch_io_mgr.cpp:136
void SetValue(int aRow, int aCol, const wxString &aValue) override
void SetValue(int aRow, int aCol, const wxString &aValue) override

References COL_TYPE, COL_URI, SCH_IO_MGR::GetLibraryFileExtension(), LIB_TABLE_GRID::SetValue(), and SCH_IO_MGR::ShowType().

◆ SetValueAsBool()

void LIB_TABLE_GRID::SetValueAsBool ( int  aRow,
int  aCol,
bool  aValue 
)
inlineoverrideinherited

Definition at line 104 of file lib_table_grid.h.

105  {
106  if( aRow < (int) size() && aCol == COL_ENABLED )
107  at( (size_t) aRow )->SetEnabled( aValue );
108  }
virtual LIB_TABLE_ROW * at(size_t aIndex)=0
void SetEnabled(bool aEnabled=true)
Change the enabled status of this library.
virtual size_t size() const =0

References LIB_TABLE_GRID::at(), COL_ENABLED, LIB_TABLE_ROW::SetEnabled(), and LIB_TABLE_GRID::size().

◆ size()

size_t SYMBOL_LIB_TABLE_GRID::size ( ) const
inlineoverrideprotectedvirtual

Implements LIB_TABLE_GRID.

Definition at line 87 of file panel_sym_lib_table.cpp.

87 { return rows.size(); }
LIB_TABLE_ROWS rows

References LIB_TABLE::rows.

◆ Type()

KICAD_T SYMBOL_LIB_TABLE::Type ( )
inlineoverridevirtualinherited

Implements PROJECT::_ELEM.

Definition at line 112 of file symbol_lib_table.h.

References SYMBOL_LIB_TABLE_T.

Friends And Related Function Documentation

◆ SYMBOL_GRID_TRICKS

friend class SYMBOL_GRID_TRICKS
friend

Definition at line 82 of file panel_sym_lib_table.cpp.

Member Data Documentation

◆ fallBack

LIB_TABLE* LIB_TABLE::fallBack
protectedinherited

◆ m_nickIndexMutex

std::recursive_mutex LIB_TABLE::m_nickIndexMutex
mutableprotectedinherited

Mutex to protect access to the nickIndex variable.

Definition at line 545 of file lib_table_base.h.

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

◆ nickIndex

INDEX LIB_TABLE::nickIndex
protectedinherited

this particular key is the nickName within each row.

Definition at line 540 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"
staticinherited

Definition at line 115 of file symbol_lib_table.h.

◆ PropPowerSymsOnly

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

◆ rows


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