KiCad PCB EDA Suite
FP_LIB_TABLE Class Reference

#include <fp_lib_table.h>

Inheritance diagram for FP_LIB_TABLE:
LIB_TABLE PROJECT::_ELEM FP_LIB_TABLE_GRID

Public Types

enum  SAVE_T { SAVE_OK, SAVE_SKIPPED }
 Enum SAVE_T is the set of return values from FootprintSave() 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...
 
 FP_LIB_TABLE (FP_LIB_TABLE *aFallBackTable=NULL)
 Constructor FP_LIB_TABLE. More...
 
bool operator== (const FP_LIB_TABLE &aFpTable) const
 
bool operator!= (const FP_LIB_TABLE &r) const
 
const FP_LIB_TABLE_ROWFindRow (const wxString &aNickName)
 Function FindRow. More...
 
void FootprintEnumerate (wxArrayString &aFootprintNames, const wxString &aNickname, bool aBestEfforts)
 Return a list of footprint names contained within the library given by aNickname. More...
 
long long GenerateTimestamp (const wxString *aNickname)
 Generate a hashed timestamp representing the last-mod-times of the library indicated by aNickname, or all libraries if aNickname is NULL. More...
 
void PrefetchLib (const wxString &aNickname)
 Function PrefetchLib If possible, prefetches the specified library (e.g. More...
 
MODULEFootprintLoad (const wxString &aNickname, const wxString &aFootprintName)
 Function FootprintLoad. More...
 
bool FootprintExists (const wxString &aNickname, const wxString &aFootprintName)
 Function FootprintExists. More...
 
const MODULEGetEnumeratedFootprint (const wxString &aNickname, const wxString &aFootprintName)
 Function GetEnumeratedFootprint. More...
 
SAVE_T FootprintSave (const wxString &aNickname, const MODULE *aFootprint, bool aOverwrite=true)
 Function FootprintSave. More...
 
void FootprintDelete (const wxString &aNickname, const wxString &aFootprintName)
 Function FootprintDelete. More...
 
bool IsFootprintLibWritable (const wxString &aNickname)
 Function IsFootprintLibWritable. More...
 
void FootprintLibDelete (const wxString &aNickname)
 
void FootprintLibCreate (const wxString &aNickname)
 
MODULEFootprintLoadWithOptionalNickname (const LIB_ID &aFootprintId)
 Function FootprintLoadWithOptionalNickname loads a footprint having aFootprintId with possibly an empty 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 (FP_LIB_TABLE &aTable)
 Function LoadGlobalTable loads the global footprint library table into aTable. More...
 
static wxString GetGlobalTableFileName ()
 Function GetGlobalTableFileName. More...
 
static const wxString GlobalPathEnvVariableName ()
 Function GlobalPathEnvVarVariableName. More...
 
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...
 

Protected Types

typedef std::map< wxString, int > INDEX
 this is a non-owning index into the LIB_TABLE_ROWS table More...
 
typedef INDEX::iterator INDEX_ITER
 
typedef INDEX::const_iterator INDEX_CITER
 
typedef INDEX::value_type INDEX_VALUE
 

Protected Member Functions

LIB_TABLE_ROWfindRow (const wxString &aNickname) const
 Return a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBack table fragment, else NULL. More...
 
LIB_TABLE_ROWfindRow (const wxString &aNickname)
 
void reindex ()
 
void ensureIndex ()
 

Protected Attributes

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

Friends

class FP_LIB_TABLE_GRID
 

Detailed Description

Definition at line 103 of file fp_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 525 of file lib_table_base.h.

◆ INDEX_CITER

typedef INDEX::const_iterator LIB_TABLE::INDEX_CITER
protectedinherited

Definition at line 527 of file lib_table_base.h.

◆ INDEX_ITER

typedef INDEX::iterator LIB_TABLE::INDEX_ITER
protectedinherited

Definition at line 526 of file lib_table_base.h.

◆ INDEX_VALUE

typedef INDEX::value_type LIB_TABLE::INDEX_VALUE
protectedinherited

Definition at line 528 of file lib_table_base.h.

Member Enumeration Documentation

◆ SAVE_T

Enum SAVE_T is the set of return values from FootprintSave() below.

Enumerator
SAVE_OK 
SAVE_SKIPPED 

Definition at line 212 of file fp_lib_table.h.

Constructor & Destructor Documentation

◆ FP_LIB_TABLE()

FP_LIB_TABLE::FP_LIB_TABLE ( FP_LIB_TABLE aFallBackTable = NULL)

Constructor FP_LIB_TABLE.

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

Definition at line 65 of file fp_lib_table.cpp.

65  :
66  LIB_TABLE( aFallBackTable )
67 {
68  // not copying fall back, simply search aFallBackTable separately
69  // if "nickName not found".
70 }
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 366 of file lib_table_base.h.

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

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

References LIB_TABLE::rows.

◆ Clear()

void LIB_TABLE::Clear ( )
inlineinherited

Delete all rows.

Definition at line 323 of file lib_table_base.h.

324  {
325  rows.clear();
326  nickIndex.clear();
327  }
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().

◆ ensureIndex()

void LIB_TABLE::ensureIndex ( )
inlineprotectedinherited

Definition at line 513 of file lib_table_base.h.

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

◆ FindRow()

const FP_LIB_TABLE_ROW * FP_LIB_TABLE::FindRow ( const wxString &  aNickName)

Function FindRow.

returns an FP_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table fragment. The PLUGIN is loaded and attached to the "plugin" field of the FP_LIB_TABLE_ROW if not already loaded.

Exceptions
IO_ERRORif aNickName cannot be found.

Definition at line 284 of file fp_lib_table.cpp.

285 {
286  // Do not optimize this code. Is done this way specifically to fix a runtime
287  // error with clang 4.0.1.
288  LIB_TABLE_ROW* ltrow = findRow( aNickname );
289  FP_LIB_TABLE_ROW* row = dynamic_cast< FP_LIB_TABLE_ROW* >( ltrow );
290 
291  if( !row )
292  {
293  wxString msg = wxString::Format(
294  _( "fp-lib-table files contain no library with nickname \"%s\"" ),
295  aNickname );
296 
297  THROW_IO_ERROR( msg );
298  }
299 
300  // We've been 'lazy' up until now, but it cannot be deferred any longer,
301  // instantiate a PLUGIN of the proper kind if it is not already in this
302  // FP_LIB_TABLE_ROW.
303  if( !row->plugin )
304  row->setPlugin( IO_MGR::PluginFind( row->type ) );
305 
306  return row;
307 }
void setPlugin(PLUGIN *aPlugin)
Definition: fp_lib_table.h:93
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
LIB_TABLE_ROW * findRow(const wxString &aNickname) const
Return a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBack table fragment,...
static PLUGIN * PluginFind(PCB_FILE_T aFileType)
Function PluginFind returns a PLUGIN which the caller can use to import, export, save,...
Definition: io_mgr.cpp:57
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:38

References _, LIB_TABLE::findRow(), Format(), FP_LIB_TABLE_ROW::plugin, IO_MGR::PluginFind(), FP_LIB_TABLE_ROW::setPlugin(), THROW_IO_ERROR, and FP_LIB_TABLE_ROW::type.

Referenced by FP_TREE_MODEL_ADAPTER::AddLibraries(), FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary(), FootprintDelete(), FootprintEnumerate(), FootprintExists(), FootprintLibCreate(), FootprintLibDelete(), FootprintLoad(), FootprintSave(), GenerateTimestamp(), GetEnumeratedFootprint(), IsFootprintLibWritable(), PrefetchLib(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), and FOOTPRINT_VIEWER_FRAME::UpdateTitle().

◆ findRow() [1/2]

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

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

Definition at line 190 of file lib_table_base.cpp.

191 {
192  LIB_TABLE* cur = (LIB_TABLE*) this;
193 
194  do
195  {
196  cur->ensureIndex();
197 
198  INDEX_CITER it = cur->nickIndex.find( aNickName );
199 
200  if( it != cur->nickIndex.end() )
201  {
202  return &cur->rows[it->second]; // found
203  }
204 
205  // not found, search fall back table(s), if any
206  } while( ( cur = cur->fallBack ) != 0 );
207 
208  return nullptr; // not found
209 }
void ensureIndex()
INDEX::const_iterator INDEX_CITER
LIB_TABLE_ROWS rows
LIB_TABLE * fallBack
INDEX nickIndex
this particular key is the nickName within each row.
Manage LIB_TABLE_ROW records (rows), and can be searched based on library nickname.

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

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

◆ findRow() [2/2]

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

Definition at line 212 of file lib_table_base.cpp.

213 {
214  LIB_TABLE* cur = (LIB_TABLE*) this;
215 
216  do
217  {
218  cur->ensureIndex();
219 
220  INDEX_ITER it = cur->nickIndex.find( aNickName );
221 
222  if( it != cur->nickIndex.end() )
223  {
224  return &cur->rows[it->second]; // found
225  }
226 
227  // not found, search fall back table(s), if any
228  } while( ( cur = cur->fallBack ) != 0 );
229 
230  return nullptr; // not found
231 }
void ensureIndex()
LIB_TABLE_ROWS rows
LIB_TABLE * fallBack
INDEX::iterator INDEX_ITER
INDEX nickIndex
this particular key is the nickName within each row.
Manage LIB_TABLE_ROW records (rows), and can be searched based on library nickname.

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

◆ FindRowByURI()

const LIB_TABLE_ROW * LIB_TABLE::FindRowByURI ( const wxString &  aURI)
inherited
Returns
a LIB_TABLE_ROW pointer if aURI is found in this table or in any chained fallBack table fragments, else NULL.

Definition at line 234 of file lib_table_base.cpp.

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

References LIB_TABLE::ensureIndex(), LIB_TABLE::fallBack, and LIB_TABLE::rows.

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

◆ FootprintDelete()

void FP_LIB_TABLE::FootprintDelete ( const wxString &  aNickname,
const wxString &  aFootprintName 
)

Function FootprintDelete.

deletes the aFootprintName from the library given by aNickname.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW.
aFootprintNameis the name of a footprint 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 402 of file fp_lib_table.cpp.

403 {
404  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
405  wxASSERT( (PLUGIN*) row->plugin );
406  return row->plugin->FootprintDelete( row->GetFullURI( true ), aFootprintName,
407  row->GetProperties() );
408 }
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
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 FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:269
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).

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

Referenced by FOOTPRINT_EDIT_FRAME::DeleteModuleFromLibrary().

◆ FootprintEnumerate()

void FP_LIB_TABLE::FootprintEnumerate ( wxArrayString &  aFootprintNames,
const wxString &  aNickname,
bool  aBestEfforts 
)

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

Parameters
aFootprintNamesis the list to fill with the footprint names found in aNickname
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW.
aBestEffortsif true, don't throw on errors
Exceptions
IO_ERRORif the library cannot be found, or footprint cannot be loaded.

Definition at line 266 of file fp_lib_table.cpp.

268 {
269  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
270  wxASSERT( (PLUGIN*) row->plugin );
271  row->plugin->FootprintEnumerate( aFootprintNames, row->GetFullURI( true ), aBestEfforts,
272  row->GetProperties() );
273 }
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
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 FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:269
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).

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

Referenced by GetFootprints(), guessNickname(), and FOOTPRINT_LIST_IMPL::JoinWorkers().

◆ FootprintExists()

bool FP_LIB_TABLE::FootprintExists ( const wxString &  aNickname,
const wxString &  aFootprintName 
)

Function FootprintExists.

indicates whether or not the given footprint already exists in the given library.

Definition at line 345 of file fp_lib_table.cpp.

346 {
347  try
348  {
349  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
350  wxASSERT( (PLUGIN*) row->plugin );
351 
352  return row->plugin->FootprintExists( row->GetFullURI( true ), aFootprintName,
353  row->GetProperties() );
354  }
355  catch( ... )
356  {
357  return false;
358  }
359 }
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
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 FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:269
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).

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

Referenced by FOOTPRINT_EDITOR_TOOLS::PasteFootprint(), and FOOTPRINT_EDIT_FRAME::SaveFootprintAs().

◆ FootprintLibCreate()

void FP_LIB_TABLE::FootprintLibCreate ( const wxString &  aNickname)

Definition at line 427 of file fp_lib_table.cpp.

428 {
429  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
430  wxASSERT( (PLUGIN*) row->plugin );
431  row->plugin->FootprintLibCreate( row->GetFullURI( true ), row->GetProperties() );
432 }
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
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 FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:269
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).

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

◆ FootprintLibDelete()

void FP_LIB_TABLE::FootprintLibDelete ( const wxString &  aNickname)

Definition at line 419 of file fp_lib_table.cpp.

420 {
421  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
422  wxASSERT( (PLUGIN*) row->plugin );
423  row->plugin->FootprintLibDelete( row->GetFullURI( true ), row->GetProperties() );
424 }
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
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 FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:269
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).

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

◆ FootprintLoad()

MODULE * FP_LIB_TABLE::FootprintLoad ( const wxString &  aNickname,
const wxString &  aFootprintName 
)

Function FootprintLoad.

loads a footprint having aFootprintName from the library given by aNickname.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW
aFootprintNameis the name of the footprint to load.
Returns
MODULE* - if found caller owns it, else NULL if not found.
Exceptions
IO_ERRORif the library cannot be found or read. No exception is thrown in the case where aFootprintName cannot be found.

Definition at line 362 of file fp_lib_table.cpp.

363 {
364  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
365  wxASSERT( (PLUGIN*) row->plugin );
366 
367  MODULE* ret = row->plugin->FootprintLoad( row->GetFullURI( true ), aFootprintName,
368  row->GetProperties() );
369 
370  setLibNickname( ret, row->GetNickName(), aFootprintName );
371 
372  return ret;
373 }
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
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
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:269
static void setLibNickname(MODULE *aModule, const wxString &aNickname, const wxString &aFootprintName)
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).

References FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE_ROW::GetProperties(), FP_LIB_TABLE_ROW::plugin, and setLibNickname().

Referenced by FootprintLoadWithOptionalNickname(), FOOTPRINT_INFO_GENERATOR::GenerateHtml(), and FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint().

◆ FootprintLoadWithOptionalNickname()

MODULE * FP_LIB_TABLE::FootprintLoadWithOptionalNickname ( const LIB_ID aFootprintId)

Function FootprintLoadWithOptionalNickname loads a footprint having aFootprintId with possibly an empty nickname.

Parameters
aFootprintIdthe [nickname] & footprint name of the footprint to load.
Returns
MODULE* - if found caller owns it, else NULL if not found.
Exceptions
IO_ERRORif the library cannot be found or read. No exception is thrown in the case where aFootprintName cannot be found.
PARSE_ERRORif aFootprintId is not parsed OK.

Definition at line 435 of file fp_lib_table.cpp.

436 {
437  wxString nickname = aFootprintId.GetLibNickname();
438  wxString fpname = aFootprintId.GetLibItemName();
439 
440  if( nickname.size() )
441  {
442  return FootprintLoad( nickname, fpname );
443  }
444 
445  // nickname is empty, sequentially search (alphabetically) all libs/nicks for first match:
446  else
447  {
448  std::vector<wxString> nicks = GetLogicalLibs();
449 
450  // Search each library going through libraries alphabetically.
451  for( unsigned i = 0; i < nicks.size(); ++i )
452  {
453  // FootprintLoad() returns NULL on not found, does not throw exception
454  // unless there's an IO_ERROR.
455  MODULE* ret = FootprintLoad( nicks[i], fpname );
456 
457  if( ret )
458  return ret;
459  }
460 
461  return NULL;
462  }
463 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
MODULE * FootprintLoad(const wxString &aNickname, const wxString &aFootprintName)
Function FootprintLoad.
#define NULL
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:97
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 FootprintLoad(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_TABLE::GetLogicalLibs(), and NULL.

Referenced by PCB_BASE_FRAME::loadFootprint(), and FP_LOADER_THREAD::ProcessEntry().

◆ FootprintSave()

FP_LIB_TABLE::SAVE_T FP_LIB_TABLE::FootprintSave ( const wxString &  aNickname,
const MODULE aFootprint,
bool  aOverwrite = true 
)

Function FootprintSave.

will write aFootprint to an existing library given by aNickname. If a footprint by the same name already exists, it is replaced.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW
aFootprintis what to store in the library. The caller continues to own the footprint after this call.
aOverwritewhen true means overwrite any existing footprint 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.

Definition at line 376 of file fp_lib_table.cpp.

378 {
379  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
380  wxASSERT( (PLUGIN*) row->plugin );
381 
382  if( !aOverwrite )
383  {
384  // Try loading the footprint to see if it already exists, caller wants overwrite
385  // protection, which is atypical, not the default.
386 
387  wxString fpname = aFootprint->GetFPID().GetLibItemName();
388 
389  std::unique_ptr<MODULE> footprint( row->plugin->FootprintLoad( row->GetFullURI( true ),
390  fpname, row->GetProperties() ) );
391 
392  if( footprint.get() )
393  return SAVE_SKIPPED;
394  }
395 
396  row->plugin->FootprintSave( row->GetFullURI( true ), aFootprint, row->GetProperties() );
397 
398  return SAVE_OK;
399 }
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
const LIB_ID & GetFPID() const
Definition: class_module.h:210
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
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 FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:269
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).

References FindRow(), MODULE::GetFPID(), LIB_TABLE_ROW::GetFullURI(), LIB_ID::GetLibItemName(), LIB_TABLE_ROW::GetProperties(), FP_LIB_TABLE_ROW::plugin, SAVE_OK, and SAVE_SKIPPED.

Referenced by PCB_EDIT_FRAME::HarvestFootprintsToLibrary(), and FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary().

◆ Format()

void FP_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 234 of file fp_lib_table.cpp.

235 {
236  aOutput->Print( aIndentLevel, "(fp_lib_table\n" );
237 
238  for( LIB_TABLE_ROWS_CITER it = rows.begin(); it != rows.end(); ++it )
239  it->Format( aOutput, aIndentLevel+1 );
240 
241  aOutput->Print( aIndentLevel, ")\n" );
242 }
LIB_TABLE_ROWS rows
LIB_TABLE_ROWS::const_iterator LIB_TABLE_ROWS_CITER
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408

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

Referenced by FOOTPRINT_ASYNC_LOADER::Start().

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

416 {
417  UTF8 ret;
418 
419  if( aProperties )
420  {
421  for( PROPERTIES::const_iterator it = aProperties->begin(); it != aProperties->end(); ++it )
422  {
423  const std::string& name = it->first;
424 
425  const UTF8& value = it->second;
426 
427  if( ret.size() )
428  ret += OPT_SEP;
429 
430  ret += name;
431 
432  // the separation between name and value is '='
433  if( value.size() )
434  {
435  ret += '=';
436 
437  for( std::string::const_iterator si = value.begin(); si != value.end(); ++si )
438  {
439  // escape any separator in the value.
440  if( *si == OPT_SEP )
441  ret += '\\';
442 
443  ret += *si;
444  }
445  }
446  }
447  }
448 
449  return ret;
450 }
UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to...
Definition: utf8.h:73
const char * name
Definition: DXF_plotter.cpp:59
std::string::const_iterator end() const
Definition: utf8.h:197
std::string::const_iterator begin() const
Definition: utf8.h:196
std::string::size_type size() const
Definition: utf8.h:115
#define OPT_SEP
options separator character

References UTF8::begin(), UTF8::end(), name, OPT_SEP, and UTF8::size().

Referenced by DIALOG_FP_PLUGIN_OPTIONS::TransferDataFromWindow().

◆ GenerateTimestamp()

long long FP_LIB_TABLE::GenerateTimestamp ( const wxString *  aNickname)

Generate a hashed timestamp representing the last-mod-times of the library indicated by aNickname, or all libraries if aNickname is NULL.

Definition at line 245 of file fp_lib_table.cpp.

246 {
247  if( aNickname )
248  {
249  const FP_LIB_TABLE_ROW* row = FindRow( *aNickname );
250  wxASSERT( (PLUGIN*) row->plugin );
251  return row->plugin->GetLibraryTimestamp( row->GetFullURI( true ) ) + wxHashTable::MakeKey( *aNickname );
252  }
253 
254  long long hash = 0;
255  for( wxString const& nickname : GetLogicalLibs() )
256  {
257  const FP_LIB_TABLE_ROW* row = FindRow( nickname );
258  wxASSERT( (PLUGIN*) row->plugin );
259  hash += row->plugin->GetLibraryTimestamp( row->GetFullURI( true ) ) + wxHashTable::MakeKey( nickname );
260  }
261 
262  return hash;
263 }
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
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 FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:269
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_ROW::GetFullURI(), LIB_TABLE::GetLogicalLibs(), and FP_LIB_TABLE_ROW::plugin.

Referenced by FOOTPRINT_LIST_IMPL::ReadFootprintFiles().

◆ GetCount()

unsigned LIB_TABLE::GetCount ( ) const
inlineinherited

Get the number of rows contained in the table.

Definition at line 356 of file lib_table_base.h.

357  {
358  return rows.size();
359  }
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 151 of file lib_table_base.cpp.

152 {
153  // use "no exception" form of find row:
154  const LIB_TABLE_ROW* row = findRow( aNickname );
155 
156  if( row )
157  return row->GetDescr();
158  else
159  return wxEmptyString;
160 }
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
const wxString & GetDescr() const
Return the description of the library referenced by this row.
LIB_TABLE_ROW * findRow(const wxString &aNickname) const
Return a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBack table fragment,...

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), LIB_EDIT_FRAME::savePartAs(), and PCB_BASE_FRAME::SelectLibrary().

◆ GetEnumeratedFootprint()

const MODULE * FP_LIB_TABLE::GetEnumeratedFootprint ( const wxString &  aNickname,
const wxString &  aFootprintName 
)

Function GetEnumeratedFootprint.

a version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management. Return value is const to allow it to return a reference to a cached item.

Definition at line 334 of file fp_lib_table.cpp.

336 {
337  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
338  wxASSERT( (PLUGIN*) row->plugin );
339 
340  return row->plugin->GetEnumeratedFootprint( row->GetFullURI( true ), aFootprintName,
341  row->GetProperties() );
342 }
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
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 FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:269
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).

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

Referenced by FOOTPRINT_INFO_IMPL::load().

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

178 {
179  const LIB_TABLE_ROW* row = findRow( aNickname );
180 
181  wxString retv;
182 
183  if( row )
184  retv = row->GetFullURI( aExpandEnvVars );
185 
186  return retv;
187 }
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
const wxString GetFullURI(bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...
LIB_TABLE_ROW * findRow(const wxString &aNickname) const
Return a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBack table fragment,...

References LIB_TABLE::findRow(), and LIB_TABLE_ROW::GetFullURI().

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

◆ GetGlobalTableFileName()

wxString FP_LIB_TABLE::GetGlobalTableFileName ( )
static

Function GetGlobalTableFileName.

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

Definition at line 516 of file fp_lib_table.cpp.

517 {
518  wxFileName fn;
519 
521  fn.SetName( global_tbl_name );
522 
523  return fn.GetFullPath();
524 }
static const wxChar global_tbl_name[]
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 PCB_BASE_EDIT_FRAME::AddLibrary(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::GetGlobalTableFileName(), InvokePcbLibTableEditor(), LoadGlobalTable(), PCB::IFACE::OnKifaceStart(), and DIALOG_GLOBAL_FP_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 270 of file lib_table_base.cpp.

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

◆ GlobalPathEnvVariableName()

const wxString FP_LIB_TABLE::GlobalPathEnvVariableName ( )
static

Function GlobalPathEnvVarVariableName.

returns the name of the environment variable used to hold the directory of locally installed "KiCad sponsored" system footprint libraries. These can be either legacy or pretty 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 466 of file fp_lib_table.cpp.

467 {
468  return "KISYSMOD";
469 }

Referenced by DIALOG_CONFIG_EQUFILES::Init(), and PANEL_FP_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 163 of file lib_table_base.cpp.

164 {
165  const LIB_TABLE_ROW* row = findRow( aNickname );
166 
167  if( row == nullptr )
168  return false;
169 
170  if( aCheckEnabled && !row->GetIsEnabled() )
171  return false;
172 
173  return true;
174 }
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
bool GetIsEnabled() const
LIB_TABLE_ROW * findRow(const wxString &aNickname) const
Return a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBack table fragment,...

References LIB_TABLE::findRow(), and LIB_TABLE_ROW::GetIsEnabled().

Referenced by CVPCB_MAINFRAME::DisplayStatus(), InvokeSchEditSymbolLibTable(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), LIB_EDIT_FRAME::KiwayMailIn(), LIB_MANAGER::LibraryExists(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_EDIT_FRAME::LoadSheetFromFile(), NETLIST_EXPORTER_GENERIC::makeLibraries(), SCH_BASE_FRAME::SelectCompFromLibTree(), LIB_VIEW_FRAME::ShowModal(), FOOTPRINT_VIEWER_FRAME::ShowModal(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), and SCH_SCREEN::UpdateSymbolLinks().

◆ InsertRow()

bool LIB_TABLE::InsertRow ( LIB_TABLE_ROW aRow,
bool  doReplace = false 
)
inherited

Adds aRow if it does not already exist or if doReplace is true.

If doReplace is not true and the key for aRow already exists, the function fails and returns false.

The key for the table is the nickName, and all in this table must be unique.

Parameters
aRowis the new row to insert, or to forcibly add if doReplace is true.
doReplaceif true, means insert regardless of whether aRow's key already exists. If false, then fail if the key already exists.
Returns
bool - true if the operation succeeded.

Definition at line 310 of file lib_table_base.cpp.

311 {
312  ensureIndex();
313 
314  INDEX_CITER it = nickIndex.find( aRow->GetNickName() );
315 
316  if( it == nickIndex.end() )
317  {
318  rows.push_back( aRow );
319  nickIndex.insert( INDEX_VALUE( aRow->GetNickName(), rows.size() - 1 ) );
320  return true;
321  }
322 
323  if( doReplace )
324  {
325  rows.replace( it->second, aRow );
326  return true;
327  }
328 
329  return false;
330 }
void ensureIndex()
INDEX::const_iterator INDEX_CITER
LIB_TABLE_ROWS rows
INDEX::value_type INDEX_VALUE
const wxString & GetNickName() const
INDEX nickIndex
this particular key is the nickName within each row.

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

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), LIB_MANAGER::addLibrary(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), PCB_EDIT_FRAME::importFile(), LIB_TABLE_TEST_FIXTURE::LIB_TABLE_TEST_FIXTURE(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_ALTIUM_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), Parse(), and SYMBOL_LIB_TABLE::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 142 of file lib_table_base.cpp.

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

◆ IsFootprintLibWritable()

bool FP_LIB_TABLE::IsFootprintLibWritable ( const wxString &  aNickname)

Function IsFootprintLibWritable.

returns true if the library given by aNickname is writable. (Often system libraries are read only because of where they are installed.)

Exceptions
IO_ERRORif no library at aLibraryPath exists.

Definition at line 411 of file fp_lib_table.cpp.

412 {
413  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
414  wxASSERT( (PLUGIN*) row->plugin );
415  return row->plugin->IsFootprintLibWritable( row->GetFullURI( true ) );
416 }
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
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 FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:269

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

Referenced by FOOTPRINT_EDIT_FRAME::updateTitle().

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

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

Function LoadGlobalTable loads the global footprint 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 FP_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 footprint library table.

Definition at line 472 of file fp_lib_table.cpp.

473 {
474  bool tableExists = true;
475  wxFileName fn = GetGlobalTableFileName();
476 
477  if( !fn.FileExists() )
478  {
479  tableExists = false;
480 
481  if( !fn.DirExists() && !fn.Mkdir( 0x777, wxPATH_MKDIR_FULL ) )
482  {
483  THROW_IO_ERROR( wxString::Format( _( "Cannot create global library table path \"%s\"." ),
484  fn.GetPath() ) );
485  }
486 
487  // Attempt to copy the default global file table from the KiCad
488  // template folder to the user's home configuration path.
489  SEARCH_STACK ss;
490 
491  SystemDirsAppend( &ss );
492 
493  wxString templatePath =
494  Pgm().GetLocalEnvVariables().at( wxT( "KICAD_TEMPLATE_DIR" ) ).GetValue();
495 
496  if( !templatePath.IsEmpty() )
497  ss.AddPaths( templatePath, 0 );
498 
499  wxString fileName = ss.FindValidPath( global_tbl_name );
500 
501  // The fallback is to create an empty global footprint table for the user to populate.
502  if( fileName.IsEmpty() || !::wxCopyFile( fileName, fn.GetFullPath(), false ) )
503  {
504  FP_LIB_TABLE emptyTable;
505 
506  emptyTable.Save( fn.GetFullPath() );
507  }
508  }
509 
510  aTable.Load( fn.GetFullPath() );
511 
512  return tableExists;
513 }
static const wxChar global_tbl_name[]
wxString FindValidPath(const wxString &aFileName) const
Definition: search_stack.h:73
SEARCH_STACK looks for files in a number of places.
Definition: search_stack.h:41
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
void SystemDirsAppend(SEARCH_STACK *aSearchStack)
Function SystemDirsAppend appends system places to aSearchStack in a platform specific way,...
void Load(const wxString &aFileName)
Load the library table using the path defined by aFileName aFallBackTable.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#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
void AddPaths(const wxString &aPaths, int aIndex=-1)
Function AddPaths insert or append path(s)
static wxString GetGlobalTableFileName()
Function GetGlobalTableFileName.

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 CV::IFACE::OnKifaceStart(), PCB::IFACE::OnKifaceStart(), and DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow().

◆ operator!=() [1/2]

bool FP_LIB_TABLE::operator!= ( const FP_LIB_TABLE r) const
inline

Definition at line 129 of file fp_lib_table.h.

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

◆ operator!=() [2/2]

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

Definition at line 351 of file lib_table_base.h.

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

◆ operator==() [1/2]

bool FP_LIB_TABLE::operator== ( const FP_LIB_TABLE aFpTable) const

Definition at line 217 of file fp_lib_table.cpp.

218 {
219  if( rows.size() == aFpTable.rows.size() )
220  {
221  for( unsigned i = 0; i < rows.size(); ++i )
222  {
223  if( (FP_LIB_TABLE_ROW&)rows[i] != (FP_LIB_TABLE_ROW&)aFpTable.rows[i] )
224  return false;
225  }
226 
227  return true;
228  }
229 
230  return false;
231 }
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
LIB_TABLE_ROWS rows

References LIB_TABLE::rows.

◆ operator==() [2/2]

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

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

References LIB_TABLE::rows.

◆ Parse()

void FP_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 73 of file fp_lib_table.cpp.

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

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

◆ PrefetchLib()

void FP_LIB_TABLE::PrefetchLib ( const wxString &  aNickname)

Function PrefetchLib If possible, prefetches the specified library (e.g.

performing downloads). Does not parse. Threadsafe.

This is a no-op for libraries that cannot be prefetched.

Parameters
aNicknameis a locator for the library; it is a name in LIB_TABLE_ROW.
Exceptions
IO_ERRORif there is an error prefetching the library.

Definition at line 276 of file fp_lib_table.cpp.

277 {
278  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
279  wxASSERT( (PLUGIN*) row->plugin );
280  row->plugin->PrefetchLib( row->GetFullURI( true ), row->GetProperties() );
281 }
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
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 FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:269
const PROPERTIES * GetProperties() const
Return the constant PROPERTIES for this library (LIB_TABLE_ROW).

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

Referenced by FOOTPRINT_LIST_IMPL::loader_job().

◆ reindex()

void LIB_TABLE::reindex ( )
inlineprotectedinherited

Definition at line 505 of file lib_table_base.h.

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

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

References LIB_TABLE::rows.

Referenced by LIB_MANAGER::addLibrary().

◆ Save()

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

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

Parameters
aFileNameis the name of the file to write to.

Definition at line 347 of file lib_table_base.cpp.

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

References LIB_TABLE::Format().

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

◆ Type()

KICAD_T FP_LIB_TABLE::Type ( )
inlineoverridevirtual

Implements PROJECT::_ELEM.

Definition at line 108 of file fp_lib_table.h.

108 { return FP_LIB_TABLE_T; }

References FP_LIB_TABLE_T.

Referenced by PROJECT::PcbFootprintLibs().

Friends And Related Function Documentation

◆ FP_LIB_TABLE_GRID

friend class FP_LIB_TABLE_GRID
friend

Definition at line 105 of file fp_lib_table.h.

Member Data Documentation

◆ fallBack

LIB_TABLE* LIB_TABLE::fallBack
protectedinherited

◆ nickIndex

INDEX LIB_TABLE::nickIndex
protectedinherited

this particular key is the nickName within each row.

Definition at line 531 of file lib_table_base.h.

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

◆ rows


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