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

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

Static Public Member Functions

static 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)
 Function ParseOptions. More...
 
static UTF8 FormatOptions (const PROPERTIES *aProperties)
 Function FormatOptions. More...
 
static const wxString ExpandSubstitutions (const wxString &aString)
 Function ExpandSubstitutions. More...
 

Protected Types

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

Protected Member Functions

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

Protected Attributes

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

Friends

class FP_LIB_TABLE_GRID
 

Detailed Description

Definition at line 103 of file fp_lib_table.h.

Member Typedef Documentation

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

this is a non-owning index into the LIB_TABLE_ROWS table

Definition at line 506 of file lib_table_base.h.

typedef INDEX::const_iterator LIB_TABLE::INDEX_CITER
protectedinherited

Definition at line 508 of file lib_table_base.h.

typedef INDEX::iterator LIB_TABLE::INDEX_ITER
protectedinherited

Definition at line 507 of file lib_table_base.h.

typedef INDEX::value_type LIB_TABLE::INDEX_VALUE
protectedinherited

Definition at line 509 of file lib_table_base.h.

Member Enumeration Documentation

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

Enumerator
SAVE_OK 
SAVE_SKIPPED 

Definition at line 187 of file fp_lib_table.h.

Constructor & Destructor Documentation

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 60 of file fp_lib_table.cpp.

60  :
61  LIB_TABLE( aFallBackTable )
62 {
63  // not copying fall back, simply search aFallBackTable separately
64  // if "nickName not found".
65 }
LIB_TABLE(LIB_TABLE *aFallBackTable=NULL)
Constructor LIB_TABLE builds a library table by pre-pending this table fragment in front of aFallBack...

Member Function Documentation

LIB_TABLE_ROW* LIB_TABLE::At ( int  aIndex)
inlineinherited

Definition at line 354 of file lib_table_base.h.

References LIB_TABLE::rows.

Referenced by FP_GRID_TRICKS::paste_text().

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

Delete all rows.

Definition at line 328 of file lib_table_base.h.

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

Referenced by DIALOG_FP_LIB_TABLE::onOKButtonClick().

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

Definition at line 494 of file lib_table_base.h.

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

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

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

Function ExpandSubstitutions.

replaces any environment variable references with their values and is here to fully embellish the TABLE_ROW::uri in a platform independent way. This enables library tables to have platform dependent environment variables in them, allowing for a uniform table across platforms.

Definition at line 512 of file lib_table_base.cpp.

References ExpandEnvVarSubstitutions().

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

513 {
514  return ExpandEnvVarSubstitutions( aString );
515 }
const wxString ExpandEnvVarSubstitutions(const wxString &aString)
Function ExpandEnvVarSubstitutions replaces any environment variable references with their values...
Definition: common.cpp:254
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 248 of file fp_lib_table.cpp.

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

Referenced by FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary(), FootprintDelete(), FootprintEnumerate(), FootprintLibCreate(), FootprintLibDelete(), FootprintLoad(), FootprintSave(), FOOTPRINT_EDIT_FRAME::getLibPath(), IsFootprintLibWritable(), PrefetchLib(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), and FOOTPRINT_EDIT_FRAME::updateTitle().

249 {
250  FP_LIB_TABLE_ROW* row = dynamic_cast< FP_LIB_TABLE_ROW* >( findRow( aNickname ) );
251 
252  if( !row )
253  {
254  wxString msg = wxString::Format(
255  _( "fp-lib-table files contain no library with nickname '%s'" ),
256  GetChars( aNickname ) );
257 
258  THROW_IO_ERROR( msg );
259  }
260 
261  // We've been 'lazy' up until now, but it cannot be deferred any longer,
262  // instantiate a PLUGIN of the proper kind if it is not already in this
263  // FP_LIB_TABLE_ROW.
264  if( !row->plugin )
265  row->setPlugin( IO_MGR::PluginFind( row->type ) );
266 
267  return row;
268 }
void setPlugin(PLUGIN *aPlugin)
Definition: fp_lib_table.h:93
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
#define THROW_IO_ERROR(x)
Definition: utf8.cpp:60
LIB_TABLE_ROW * findRow(const wxString &aNickname) const
Function findRow returns a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBa...
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
static PLUGIN * PluginFind(PCB_FILE_T aFileType)
Function PluginFind returns a PLUGIN which the caller can use to import, export, save, or load design documents.
Definition: io_mgr.cpp:58
LIB_TABLE_ROW * LIB_TABLE::findRow ( const wxString &  aNickname) const
protectedinherited

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

Definition at line 254 of file lib_table_base.cpp.

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

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

255 {
256  LIB_TABLE* cur = (LIB_TABLE*) this;
257 
258  do
259  {
260  cur->ensureIndex();
261 
262  INDEX_CITER it = cur->nickIndex.find( aNickName );
263 
264  if( it != cur->nickIndex.end() )
265  {
266  return &cur->rows[it->second]; // found
267  }
268 
269  // not found, search fall back table(s), if any
270  } while( ( cur = cur->fallBack ) != 0 );
271 
272  return NULL; // not found
273 }
void ensureIndex()
INDEX::const_iterator INDEX_CITER
LIB_TABLE_ROWS rows
LIB_TABLE * fallBack
INDEX nickIndex
this particular key is the nickName within each row.
Class LIB_TABLE.
const LIB_TABLE_ROW * LIB_TABLE::FindRowByURI ( const wxString &  aURI)
inherited

Function FindRowByURI.

Returns
a LIB_TABLE_ROW pointer if aURI is found in this table or in any chained fallBack table fragments, else NULL.

Definition at line 276 of file lib_table_base.cpp.

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

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

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

Referenced by FOOTPRINT_EDIT_FRAME::DeleteModuleFromCurrentLibrary().

329 {
330  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
331  wxASSERT( (PLUGIN*) row->plugin );
332  return row->plugin->FootprintDelete( row->GetFullURI( true ), aFootprintName,
333  row->GetProperties() );
334 }
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
const PROPERTIES * GetProperties() const
Function GetProperties.
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
Class PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:193
virtual void FootprintDelete(const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties=NULL)
Function FootprintDelete deletes aFootprintName from the library at aLibraryPath. ...
Definition: plugin.cpp:92
void FP_LIB_TABLE::FootprintEnumerate ( wxArrayString &  aFootprintNames,
const wxString &  aNickname 
)

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.
Exceptions
IO_ERRORif the library cannot be found, or footprint cannot be loaded.

Definition at line 231 of file fp_lib_table.cpp.

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

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

232 {
233  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
234  wxASSERT( (PLUGIN*) row->plugin );
235  row->plugin->FootprintEnumerate( aFootprintNames, row->GetFullURI( true ),
236  row->GetProperties() );
237 }
virtual void FootprintEnumerate(wxArrayString &aFootprintNames, const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL)
Return a list of footprint names contained within the library at aLibraryPath.
Definition: plugin.cpp:61
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
const PROPERTIES * GetProperties() const
Function GetProperties.
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
Class PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:193
void FP_LIB_TABLE::FootprintLibCreate ( const wxString &  aNickname)

Definition at line 353 of file fp_lib_table.cpp.

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

354 {
355  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
356  wxASSERT( (PLUGIN*) row->plugin );
357  row->plugin->FootprintLibCreate( row->GetFullURI( true ), row->GetProperties() );
358 }
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
const PROPERTIES * GetProperties() const
Function GetProperties.
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
Class PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:193
virtual void FootprintLibCreate(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL)
Function FootprintLibCreate creates a new empty footprint library at aLibraryPath empty...
Definition: plugin.cpp:99
void FP_LIB_TABLE::FootprintLibDelete ( const wxString &  aNickname)

Definition at line 345 of file fp_lib_table.cpp.

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

346 {
347  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
348  wxASSERT( (PLUGIN*) row->plugin );
349  row->plugin->FootprintLibDelete( row->GetFullURI( true ), row->GetProperties() );
350 }
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
const PROPERTIES * GetProperties() const
Function GetProperties.
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
virtual bool FootprintLibDelete(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL)
Function FootprintLibDelete deletes an existing footprint library and returns true, or if library does not exist returns false, or throws an exception if library exists but is read only or cannot be deleted for some other reason.
Definition: plugin.cpp:106
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
Class PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:193
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 271 of file fp_lib_table.cpp.

References FindRow(), PLUGIN::FootprintLoad(), FROM_UTF8(), MODULE::GetFPID(), LIB_TABLE_ROW::GetFullURI(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE_ROW::GetProperties(), FP_LIB_TABLE_ROW::plugin, LIB_ID::SetLibNickname(), and TO_UTF8.

Referenced by FootprintLoadWithOptionalNickname(), DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_INFO_IMPL::load(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), and FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint().

272 {
273  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
274  wxASSERT( (PLUGIN*) row->plugin );
275 
276  MODULE* ret = row->plugin->FootprintLoad( row->GetFullURI( true ), aFootprintName,
277  row->GetProperties() );
278 
279  // The library cannot know its own name, because it might have been renamed or moved.
280  // Therefore footprints cannot know their own library nickname when residing in
281  // a footprint library.
282  // Only at this API layer can we tell the footprint about its actual library nickname.
283  if( ret )
284  {
285  // remove "const"-ness, I really do want to set nickname without
286  // having to copy the LIB_ID and its two strings, twice each.
287  LIB_ID& fpid = (LIB_ID&) ret->GetFPID();
288 
289  // Catch any misbehaving plugin, which should be setting internal footprint name properly:
290  wxASSERT( aFootprintName == FROM_UTF8( fpid.GetLibItemName() ) );
291 
292  // and clearing nickname
293  wxASSERT( !fpid.GetLibNickname().size() );
294 
295  fpid.SetLibNickname( TO_UTF8( row->GetNickName() ) );
296  }
297 
298  return ret;
299 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
const PROPERTIES * GetProperties() const
Function GetProperties.
Class LIB_ID.
Definition: lib_id.h:56
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
const LIB_ID & GetFPID() const
Definition: class_module.h:164
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
virtual MODULE * FootprintLoad(const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties=NULL)
Function FootprintLoad loads a footprint having aFootprintName from the aLibraryPath containing a lib...
Definition: plugin.cpp:76
const UTF8 & GetLibItemName() const
Function GetLibItemName.
Definition: lib_id.h:129
int SetLibNickname(const UTF8 &aNickname)
Function SetLibNickname.
Definition: lib_id.cpp:219
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
const wxString & GetNickName() const
Function GetNickName.
Class PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:193
const UTF8 & GetLibNickname() const
Function GetLibNickname.
Definition: lib_id.h:108
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 361 of file fp_lib_table.cpp.

References FootprintLoad(), FROM_UTF8(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), and LIB_TABLE::GetLogicalLibs().

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

362 {
363  wxString nickname = FROM_UTF8( aFootprintId.GetLibNickname() );
364  wxString fpname = FROM_UTF8( aFootprintId.GetLibItemName() );
365 
366  if( nickname.size() )
367  {
368  return FootprintLoad( nickname, fpname );
369  }
370 
371  // nickname is empty, sequentially search (alphabetically) all libs/nicks for first match:
372  else
373  {
374  std::vector<wxString> nicks = GetLogicalLibs();
375 
376  // Search each library going through libraries alphabetically.
377  for( unsigned i = 0; i < nicks.size(); ++i )
378  {
379  // FootprintLoad() returns NULL on not found, does not throw exception
380  // unless there's an IO_ERROR.
381  MODULE* ret = FootprintLoad( nicks[i], fpname );
382 
383  if( ret )
384  return ret;
385  }
386 
387  return NULL;
388  }
389 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
MODULE * FootprintLoad(const wxString &aNickname, const wxString &aFootprintName)
Function FootprintLoad.
const UTF8 & GetLibItemName() const
Function GetLibItemName.
Definition: lib_id.h:129
const UTF8 & GetLibNickname() const
Function GetLibNickname.
Definition: lib_id.h:108
std::vector< wxString > GetLogicalLibs()
Function GetLogicalLibs.
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 302 of file fp_lib_table.cpp.

References FindRow(), PLUGIN::FootprintLoad(), PLUGIN::FootprintSave(), FROM_UTF8(), 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::ArchiveModulesOnBoard(), and FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary().

304 {
305  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
306  wxASSERT( (PLUGIN*) row->plugin );
307 
308  if( !aOverwrite )
309  {
310  // Try loading the footprint to see if it already exists, caller wants overwrite
311  // protection, which is atypical, not the default.
312 
313  wxString fpname = FROM_UTF8( aFootprint->GetFPID().GetLibItemName() );
314 
315  std::unique_ptr<MODULE> footprint( row->plugin->FootprintLoad( row->GetFullURI( true ),
316  fpname, row->GetProperties() ) );
317 
318  if( footprint.get() )
319  return SAVE_SKIPPED;
320  }
321 
322  row->plugin->FootprintSave( row->GetFullURI( true ), aFootprint, row->GetProperties() );
323 
324  return SAVE_OK;
325 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
const PROPERTIES * GetProperties() const
Function GetProperties.
virtual void FootprintSave(const wxString &aLibraryPath, const MODULE *aFootprint, const PROPERTIES *aProperties=NULL)
Function FootprintSave will write aModule to an existing library located at aLibraryPath.
Definition: plugin.cpp:85
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
const LIB_ID & GetFPID() const
Definition: class_module.h:164
virtual MODULE * FootprintLoad(const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties=NULL)
Function FootprintLoad loads a footprint having aFootprintName from the aLibraryPath containing a lib...
Definition: plugin.cpp:76
const UTF8 & GetLibItemName() const
Function GetLibItemName.
Definition: lib_id.h:129
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
Class PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:193
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 220 of file fp_lib_table.cpp.

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

Referenced by FOOTPRINT_ASYNC_LOADER::IsSameTable(), PCB_EDIT_FRAME::Process_Config(), FOOTPRINT_EDIT_FRAME::ProcessPreferences(), and FOOTPRINT_ASYNC_LOADER::Start().

221 {
222  aOutput->Print( aIndentLevel, "(fp_lib_table\n" );
223 
224  for( LIB_TABLE_ROWS_CITER it = rows.begin(); it != rows.end(); ++it )
225  it->Format( aOutput, aIndentLevel+1 );
226 
227  aOutput->Print( aIndentLevel, ")\n" );
228 }
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
UTF8 LIB_TABLE::FormatOptions ( const PROPERTIES aProperties)
staticinherited

Function FormatOptions.

returns a list of options from the aProperties parameter. The name=value pairs will be separated with the '|' character. The =value portion may not be present. You might expect something like "name1=value1|name2=value2|flag_me". Notice that flag_me does not have a value. This is ok.

Parameters
aPropertiesis the PROPERTIES to format or NULL. If NULL the returned string will be empty.

Definition at line 474 of file lib_table_base.cpp.

References name, and OPT_SEP.

Referenced by DIALOG_FP_PLUGIN_OPTIONS::makeResult().

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

Definition at line 352 of file lib_table_base.h.

References LIB_TABLE::rows.

Referenced by FP_GRID_TRICKS::paste_text().

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

Function GetDescription.

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

Definition at line 242 of file lib_table_base.cpp.

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

Referenced by PCB_BASE_FRAME::SelectLibrary().

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

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

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

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

Definition at line 380 of file lib_table_base.cpp.

References LIB_TABLE::fallBack, and LIB_TABLE::rows.

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

Function GetGlobalTableFileName.

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

Definition at line 432 of file fp_lib_table.cpp.

References GetKicadConfigPath(), and global_tbl_name.

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

433 {
434  wxFileName fn;
435 
436  fn.SetPath( GetKicadConfigPath() );
437  fn.SetName( global_tbl_name );
438 
439  return fn.GetFullPath();
440 }
static const wxChar global_tbl_name[]
wxString GetKicadConfigPath()
Function GetKicadConfigPath.
Definition: common.cpp:217
std::vector< wxString > LIB_TABLE::GetLogicalLibs ( )
inherited

Function GetLogicalLibs.

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

Definition at line 305 of file lib_table_base.cpp.

References LIB_TABLE::fallBack, and LIB_TABLE::rows.

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

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

Referenced by WIZARD_FPLIB_TABLE::LIBRARY::GetAutoPath(), DIALOG_CONFIG_EQUFILES::Init(), DIALOG_FP_LIB_TABLE::populateEnvironReadOnlyTable(), and WIZARD_FPLIB_TABLE::WIZARD_FPLIB_TABLE().

393 {
394  return "KISYSMOD";
395 }
bool LIB_TABLE::InsertRow ( LIB_TABLE_ROW aRow,
bool  doReplace = false 
)
inherited

Function InsertRow.

adds aRow if it does not already exist or if doReplace is true. If doReplace is not true and the key for aRow already exists, the function fails and returns false.

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

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

Definition at line 336 of file lib_table_base.cpp.

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

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

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

Function IsEmpty.

Parameters
aIncludeFallbackis used to determine if the fallback table should be included in the test.
Returns
true if the footprint library table is empty.

Definition at line 233 of file lib_table_base.cpp.

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

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

234 {
235  if( !aIncludeFallback || !fallBack )
236  return rows.empty();
237 
238  return rows.empty() && fallBack->IsEmpty( true );
239 }
LIB_TABLE_ROWS rows
LIB_TABLE * fallBack
bool IsEmpty(bool aIncludeFallback=true)
Function IsEmpty.
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 337 of file fp_lib_table.cpp.

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

Referenced by FOOTPRINT_EDIT_FRAME::updateTitle().

338 {
339  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
340  wxASSERT( (PLUGIN*) row->plugin );
341  return row->plugin->IsFootprintLibWritable( row->GetFullURI( true ) );
342 }
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
virtual bool IsFootprintLibWritable(const wxString &aLibraryPath)
Function IsFootprintLibWritable returns true iff the library at aLibraryPath is writable.
Definition: plugin.cpp:114
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
Class PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:193
void LIB_TABLE::Load ( const wxString &  aFileName)
inherited

Function Load.

loads the library table using the path defined by aFileName aFallBackTable.

Parameters
aFileNamecontains the full path to the s-expression file.
Exceptions
IO_ERRORif an error occurs attempting to load the footprint library table.

Definition at line 359 of file lib_table_base.cpp.

References LIB_TABLE::Parse().

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

361 {
362  // It's OK if footprint library tables are missing.
363  if( wxFileName::IsFileReadable( aFileName ) )
364  {
365  FILE_LINE_READER reader( aFileName );
366  LIB_TABLE_LEXER lexer( &reader );
367 
368  Parse( &lexer );
369  }
370 }
Class FILE_LINE_READER is a LINE_READER that reads from an open file.
Definition: richio.h:180
virtual void Parse(LIB_TABLE_LEXER *aLexer)=0
Function Parse.
Class LIB_TABLE_LEXER is an automatically generated class using the TokenList2DnsLexer.cmake technology, based on keywords provided by file: /home/kicad/workspace/kicad-doxygen/common/lib_table.keywords.
bool 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 398 of file fp_lib_table.cpp.

References SEARCH_STACK::FindValidPath(), Format(), GetChars(), GetGlobalTableFileName(), global_tbl_name, Kiface(), KIFACE_I::KifaceSearch(), LIB_TABLE::Load(), LIB_TABLE::Save(), and THROW_IO_ERROR.

Referenced by CV::IFACE::OnKifaceStart(), and PCB::IFACE::OnKifaceStart().

399 {
400  bool tableExists = true;
401  wxFileName fn = GetGlobalTableFileName();
402 
403  if( !fn.FileExists() )
404  {
405  tableExists = false;
406 
407  if( !fn.DirExists() && !fn.Mkdir( 0x777, wxPATH_MKDIR_FULL ) )
408  {
409  THROW_IO_ERROR( wxString::Format( _( "Cannot create global library table path '%s'." ),
410  GetChars( fn.GetPath() ) ) );
411  }
412 
413  // Attempt to copy the default global file table from the KiCad
414  // template folder to the user's home configuration path.
415  wxString fileName = Kiface().KifaceSearch().FindValidPath( global_tbl_name );
416 
417  // The fallback is to create an empty global footprint table for the user to populate.
418  if( fileName.IsEmpty() || !::wxCopyFile( fileName, fn.GetFullPath(), false ) )
419  {
420  FP_LIB_TABLE emptyTable;
421 
422  emptyTable.Save( fn.GetFullPath() );
423  }
424  }
425 
426  aTable.Load( fn.GetFullPath() );
427 
428  return tableExists;
429 }
static const wxChar global_tbl_name[]
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: kicad.cpp:52
SEARCH_STACK & KifaceSearch()
Only for DSO specific 'non-library' files.
Definition: kiface_i.h:127
void Save(const wxString &aFileName) const
Function Save.
#define THROW_IO_ERROR(x)
Definition: utf8.cpp:60
void Load(const wxString &aFileName)
Function Load.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
wxString FindValidPath(const wxString &aFileName) const
Definition: search_stack.h:71
static wxString GetGlobalTableFileName()
Function GetGlobalTableFileName.
bool FP_LIB_TABLE::operator!= ( const FP_LIB_TABLE r) const
inline

Definition at line 128 of file fp_lib_table.h.

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

Definition at line 350 of file lib_table_base.h.

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

Definition at line 203 of file fp_lib_table.cpp.

References LIB_TABLE::rows.

204 {
205  if( rows.size() == aFpTable.rows.size() )
206  {
207  for( unsigned i = 0; i < rows.size(); ++i )
208  {
209  if( (FP_LIB_TABLE_ROW&)rows[i] != (FP_LIB_TABLE_ROW&)aFpTable.rows[i] )
210  return false;
211  }
212 
213  return true;
214  }
215 
216  return false;
217 }
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
LIB_TABLE_ROWS rows
bool LIB_TABLE::operator== ( const LIB_TABLE r) const
inlineinherited

Definition at line 334 of file lib_table_base.h.

References LIB_TABLE::rows.

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

Function Parse.

Parses the LIB_TABLE_LEXER s-expression library table format into the appropriate LIB_TABLE_ROW objects.

Parameters
aLexeris the lexer to parse.
Exceptions
IO_ERRORif an I/O error occurs during parsing.
PARSER_ERRORif the lexer format to parse is invalid.
boost::bad_pointerif an any attempt to add an invalid pointer to the boost::ptr_vector.
boost::bad_indexif an index outside the row table bounds is accessed.

Implements LIB_TABLE.

Definition at line 68 of file fp_lib_table.cpp.

References DSNLEXER::CurLineNumber(), LIB_TABLE_LEXER::CurTok(), DSNLEXER::Duplicate(), DSNLEXER::Expecting(), Format(), DSNLEXER::FromUTF8(), GetChars(), LIB_TABLE::InsertRow(), DSNLEXER::NeedLEFT(), DSNLEXER::NeedRIGHT(), LIB_TABLE_LEXER::NeedSYMBOLorNUMBER(), LIB_TABLE_LEXER::NextTok(), FP_LIB_TABLE_T::T_descr, DSN::T_EOF, FP_LIB_TABLE_T::T_fp_lib_table, DSN::T_LEFT, FP_LIB_TABLE_T::T_lib, TLIB_T::T_name, FP_LIB_TABLE_T::T_options, DSN::T_RIGHT, DSN::T_type, FP_LIB_TABLE_T::T_uri, THROW_IO_ERROR, and DSNLEXER::Unexpected().

Referenced by FP_GRID_TRICKS::paste_text().

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

Function ParseOptions.

parses aOptionsList and places the result into a PROPERTIES object which is returned. If the options field is empty, then the returned PROPERTIES will be a NULL pointer.

Typically aOptionsList comes from the "options" field within a LIB_TABLE_ROW and the format is simply a comma separated list of name value pairs. e.g.: [name1[=value1][|name2[=value2]]] etc. When using the UI to create or edit a library table, this formatting is handled for you.

Definition at line 413 of file lib_table_base.cpp.

References name, and OPT_SEP.

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

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

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

Referenced by FOOTPRINT_LIST_IMPL::loader_job().

241 {
242  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
243  wxASSERT( (PLUGIN*) row->plugin );
244  row->plugin->PrefetchLib( row->GetFullURI( true ), row->GetProperties() );
245 }
virtual void PrefetchLib(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL)
Function PrefetchLib If possible, prefetches the specified library (e.g.
Definition: plugin.cpp:69
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
const PROPERTIES * GetProperties() const
Function GetProperties.
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:98
const FP_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
Class PLUGIN is a base class that BOARD loading and saving plugins should derive from.
Definition: io_mgr.h:193
void LIB_TABLE::reindex ( )
inlineprotectedinherited

Definition at line 486 of file lib_table_base.h.

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

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

487  {
488  nickIndex.clear();
489 
490  for( LIB_TABLE_ROWS_ITER it = rows.begin(); it != rows.end(); ++it )
491  nickIndex.insert( INDEX_VALUE( it->GetNickName(), it - rows.begin() ) );
492  }
LIB_TABLE_ROWS rows
INDEX::value_type INDEX_VALUE
LIB_TABLE_ROWS::iterator LIB_TABLE_ROWS_ITER
INDEX nickIndex
this particular key is the nickName within each row.
void LIB_TABLE::Save ( const wxString &  aFileName) const
inherited

Function Save.

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

Parameters
aFileNameis the name of the file to write to.

Definition at line 373 of file lib_table_base.cpp.

References LIB_TABLE::Format().

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

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

Friends And Related Function Documentation

friend class FP_LIB_TABLE_GRID
friend

Definition at line 105 of file fp_lib_table.h.

Member Data Documentation

LIB_TABLE* LIB_TABLE::fallBack
protectedinherited
INDEX LIB_TABLE::nickIndex
protectedinherited

this particular key is the nickName within each row.

Definition at line 512 of file lib_table_base.h.

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


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