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
 Function Format. More...
 
 FP_LIB_TABLE (FP_LIB_TABLE *aFallBackTable=NULL)
 Constructor FP_LIB_TABLE. More...
 
const FP_LIB_TABLE_ROWFindRow (const wxString &aNickName) throw ( IO_ERROR )
 Function FindRow. More...
 
wxArrayString FootprintEnumerate (const wxString &aNickname)
 Function FootprintEnumerate returns 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) throw ( IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception )
 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) throw ( IO_ERROR )
 Function Load. More...
 
void Save (const wxString &aFileName) const throw ( IO_ERROR, boost::interprocess::lock_exception )
 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) throw (IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception )
 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 509 of file lib_table_base.h.

typedef INDEX::const_iterator LIB_TABLE::INDEX_CITER
protectedinherited

Definition at line 511 of file lib_table_base.h.

typedef INDEX::iterator LIB_TABLE::INDEX_ITER
protectedinherited

Definition at line 510 of file lib_table_base.h.

typedef INDEX::value_type LIB_TABLE::INDEX_VALUE
protectedinherited

Definition at line 512 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 184 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 356 of file lib_table_base.h.

References LIB_TABLE::rows.

Referenced by FP_GRID_TRICKS::paste_text().

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

Delete all rows.

Definition at line 330 of file lib_table_base.h.

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

Referenced by DIALOG_FP_LIB_TABLE::onOKButtonClick().

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

Definition at line 497 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().

498  {
499  // The dialog lib table editor may not maintain the nickIndex.
500  // Lazy indexing may be required. To handle lazy indexing, we must enforce
501  // that "nickIndex" is either empty or accurate, but never inaccurate.
502  if( !nickIndex.size() )
503  reindex();
504  }
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 513 of file lib_table_base.cpp.

References ExpandEnvVarSubstitutions().

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

514 {
515  return ExpandEnvVarSubstitutions( aString );
516 }
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)
throw (IO_ERROR
)

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

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

218 {
219  FP_LIB_TABLE_ROW* row = dynamic_cast< FP_LIB_TABLE_ROW* >( findRow( aNickname ) );
220 
221  if( !row )
222  {
223  wxString msg = wxString::Format(
224  _( "fp-lib-table files contain no library with nickname '%s'" ),
225  GetChars( aNickname ) );
226 
227  THROW_IO_ERROR( msg );
228  }
229 
230  // We've been 'lazy' up until now, but it cannot be deferred any longer,
231  // instantiate a PLUGIN of the proper kind if it is not already in this
232  // FP_LIB_TABLE_ROW.
233  if( !row->plugin )
234  row->setPlugin( IO_MGR::PluginFind( row->type ) );
235 
236  return row;
237 }
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 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 297 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().

298 {
299  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
300  wxASSERT( (PLUGIN*) row->plugin );
301  return row->plugin->FootprintDelete( row->GetFullURI( true ), aFootprintName,
302  row->GetProperties() );
303 }
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
wxArrayString FP_LIB_TABLE::FootprintEnumerate ( const wxString &  aNickname)

Function FootprintEnumerate returns a list of footprint names contained within the library given by aNickname.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW.
Returns
wxArrayString - is the array of available footprint names inside a library
Exceptions
IO_ERRORif the library cannot be found, or footprint cannot be loaded.

Definition at line 200 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().

201 {
202  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
203  wxASSERT( (PLUGIN*) row->plugin );
204  return row->plugin->FootprintEnumerate( row->GetFullURI( true ), row->GetProperties() );
205 }
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 wxArrayString FootprintEnumerate(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL)
Function FootprintEnumerate returns a list of footprint names contained within the library at aLibrar...
Definition: plugin.cpp:61
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 322 of file fp_lib_table.cpp.

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

323 {
324  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
325  wxASSERT( (PLUGIN*) row->plugin );
326  row->plugin->FootprintLibCreate( row->GetFullURI( true ), row->GetProperties() );
327 }
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 314 of file fp_lib_table.cpp.

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

315 {
316  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
317  wxASSERT( (PLUGIN*) row->plugin );
318  row->plugin->FootprintLibDelete( row->GetFullURI( true ), row->GetProperties() );
319 }
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 240 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 DISPLAY_FOOTPRINTS_FRAME::Get_Module(), FOOTPRINT_INFO_IMPL::load(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), and FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint().

241 {
242  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
243  wxASSERT( (PLUGIN*) row->plugin );
244 
245  MODULE* ret = row->plugin->FootprintLoad( row->GetFullURI( true ), aFootprintName,
246  row->GetProperties() );
247 
248  // The library cannot know its own name, because it might have been renamed or moved.
249  // Therefore footprints cannot know their own library nickname when residing in
250  // a footprint library.
251  // Only at this API layer can we tell the footprint about its actual library nickname.
252  if( ret )
253  {
254  // remove "const"-ness, I really do want to set nickname without
255  // having to copy the LIB_ID and its two strings, twice each.
256  LIB_ID& fpid = (LIB_ID&) ret->GetFPID();
257 
258  // Catch any misbehaving plugin, which should be setting internal footprint name properly:
259  wxASSERT( aFootprintName == FROM_UTF8( fpid.GetLibItemName() ) );
260 
261  // and clearing nickname
262  wxASSERT( !fpid.GetLibNickname().size() );
263 
264  fpid.SetLibNickname( TO_UTF8( row->GetNickName() ) );
265  }
266 
267  return ret;
268 }
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:151
#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)
throw ( IO_ERROR,
PARSE_ERROR,
boost::interprocess::lock_exception
)

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

References FROM_UTF8().

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

332 {
333  wxString nickname = FROM_UTF8( aFootprintId.GetLibNickname() );
334  wxString fpname = FROM_UTF8( aFootprintId.GetLibItemName() );
335 
336  if( nickname.size() )
337  {
338  return FootprintLoad( nickname, fpname );
339  }
340 
341  // nickname is empty, sequentially search (alphabetically) all libs/nicks for first match:
342  else
343  {
344  std::vector<wxString> nicks = GetLogicalLibs();
345 
346  // Search each library going through libraries alphabetically.
347  for( unsigned i = 0; i < nicks.size(); ++i )
348  {
349  // FootprintLoad() returns NULL on not found, does not throw exception
350  // unless there's an IO_ERROR.
351  MODULE* ret = FootprintLoad( nicks[i], fpname );
352 
353  if( ret )
354  return ret;
355  }
356 
357  return NULL;
358  }
359 }
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 271 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().

273 {
274  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
275  wxASSERT( (PLUGIN*) row->plugin );
276 
277  if( !aOverwrite )
278  {
279  // Try loading the footprint to see if it already exists, caller wants overwrite
280  // protection, which is atypical, not the default.
281 
282  wxString fpname = FROM_UTF8( aFootprint->GetFPID().GetLibItemName() );
283 
284  std::unique_ptr<MODULE> footprint( row->plugin->FootprintLoad( row->GetFullURI( true ),
285  fpname, row->GetProperties() ) );
286 
287  if( footprint.get() )
288  return SAVE_SKIPPED;
289  }
290 
291  row->plugin->FootprintSave( row->GetFullURI( true ), aFootprint, row->GetProperties() );
292 
293  return SAVE_OK;
294 }
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:151
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

Function Format.

Generates the table s-expression format to the aOutput with an indention level of aIndentLevel.

Parameters
aOutputis the #OUTPUTFORMATER 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 189 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().

190 {
191  aOutput->Print( aIndentLevel, "(fp_lib_table\n" );
192 
193  for( LIB_TABLE_ROWS_CITER it = rows.begin(); it != rows.end(); ++it )
194  it->Format( aOutput, aIndentLevel+1 );
195 
196  aOutput->Print( aIndentLevel, ")\n" );
197 }
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 475 of file lib_table_base.cpp.

References name, and OPT_SEP.

Referenced by DIALOG_FP_PLUGIN_OPTIONS::makeResult().

476 {
477  UTF8 ret;
478 
479  if( aProperties )
480  {
481  for( PROPERTIES::const_iterator it = aProperties->begin(); it != aProperties->end(); ++it )
482  {
483  const std::string& name = it->first;
484 
485  const UTF8& value = it->second;
486 
487  if( ret.size() )
488  ret += OPT_SEP;
489 
490  ret += name;
491 
492  // the separation between name and value is '='
493  if( value.size() )
494  {
495  ret += '=';
496 
497  for( std::string::const_iterator si = value.begin(); si != value.end(); ++si )
498  {
499  // escape any separator in the value.
500  if( *si == OPT_SEP )
501  ret += '\\';
502 
503  ret += *si;
504  }
505  }
506  }
507  }
508 
509  return ret;
510 }
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 354 of file lib_table_base.h.

References LIB_TABLE::rows.

Referenced by FP_GRID_TRICKS::paste_text().

354 { 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 381 of file lib_table_base.cpp.

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

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

References GetKicadConfigPath(), and global_tbl_name.

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

404 {
405  wxFileName fn;
406 
407  fn.SetPath( GetKicadConfigPath() );
408  fn.SetName( global_tbl_name );
409 
410  return fn.GetFullPath();
411 }
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(), guessNickname(), CVPCB_MAINFRAME::LoadFootprintFiles(), 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 362 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().

363 {
364  return "KISYSMOD";
365 }
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 306 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().

307 {
308  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
309  wxASSERT( (PLUGIN*) row->plugin );
310  return row->plugin->IsFootprintLibWritable( row->GetFullURI( true ) );
311 }
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)
throw (IO_ERROR
)
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.

Referenced by 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)
throw (IO_ERROR,
PARSE_ERROR,
boost::interprocess::lock_exception
)
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 368 of file fp_lib_table.cpp.

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

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

370 {
371  bool tableExists = true;
372  wxFileName fn = GetGlobalTableFileName();
373 
374  if( !fn.FileExists() )
375  {
376  tableExists = false;
377 
378  if( !fn.DirExists() && !fn.Mkdir( 0x777, wxPATH_MKDIR_FULL ) )
379  {
380  THROW_IO_ERROR( wxString::Format( _( "Cannot create global library table path '%s'." ),
381  GetChars( fn.GetPath() ) ) );
382  }
383 
384  // Attempt to copy the default global file table from the KiCad
385  // template folder to the user's home configuration path.
386  wxString fileName = Kiface().KifaceSearch().FindValidPath( global_tbl_name );
387 
388  // The fallback is to create an empty global footprint table for the user to populate.
389  if( fileName.IsEmpty() || !::wxCopyFile( fileName, fn.GetFullPath(), false ) )
390  {
391  FP_LIB_TABLE emptyTable;
392 
393  emptyTable.Save( fn.GetFullPath() );
394  }
395  }
396 
397  aTable.Load( fn.GetFullPath() );
398 
399  return tableExists;
400 }
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:125
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 LIB_TABLE::operator!= ( const LIB_TABLE r) const
inlineinherited

Definition at line 352 of file lib_table_base.h.

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

Definition at line 336 of file lib_table_base.h.

References LIB_TABLE::rows.

337  {
338  if( rows.size() == r.rows.size() )
339  {
340  unsigned i;
341 
342  for( i = 0; i < rows.size() && rows[i] == r.rows[i]; ++i )
343  ;
344 
345  if( i == rows.size() )
346  return true;
347  }
348 
349  return false;
350  }
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::CurLine(), DSNLEXER::CurLineNumber(), DSNLEXER::CurOffset(), DSNLEXER::CurSource(), 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_PARSE_ERROR, and DSNLEXER::Unexpected().

Referenced by FP_GRID_TRICKS::paste_text().

69 {
70  T tok;
71 
72  // This table may be nested within a larger s-expression, or not.
73  // Allow for parser of that optional containing s-epression to have looked ahead.
74  if( in->CurTok() != T_fp_lib_table )
75  {
76  in->NeedLEFT();
77  if( ( tok = in->NextTok() ) != T_fp_lib_table )
78  in->Expecting( T_fp_lib_table );
79  }
80 
81  while( ( tok = in->NextTok() ) != T_RIGHT )
82  {
83  std::unique_ptr< FP_LIB_TABLE_ROW > row( new FP_LIB_TABLE_ROW );
84 
85  if( tok == T_EOF )
86  in->Expecting( T_RIGHT );
87 
88  if( tok != T_LEFT )
89  in->Expecting( T_LEFT );
90 
91  // in case there is a "row integrity" error, tell where later.
92  int lineNum = in->CurLineNumber();
93  int offset = in->CurOffset();
94 
95  if( ( tok = in->NextTok() ) != T_lib )
96  in->Expecting( T_lib );
97 
98  // (name NICKNAME)
99  in->NeedLEFT();
100 
101  if( ( tok = in->NextTok() ) != T_name )
102  in->Expecting( T_name );
103 
104  in->NeedSYMBOLorNUMBER();
105 
106  row->SetNickName( in->FromUTF8() );
107 
108  in->NeedRIGHT();
109 
110  // After (name), remaining (lib) elements are order independent, and in
111  // some cases optional.
112  bool sawType = false;
113  bool sawOpts = false;
114  bool sawDesc = false;
115  bool sawUri = false;
116 
117  while( ( tok = in->NextTok() ) != T_RIGHT )
118  {
119  if( tok == T_EOF )
120  in->Unexpected( T_EOF );
121 
122  if( tok != T_LEFT )
123  in->Expecting( T_LEFT );
124 
125  tok = in->NeedSYMBOLorNUMBER();
126 
127  switch( tok )
128  {
129  case T_uri:
130  if( sawUri )
131  in->Duplicate( tok );
132  sawUri = true;
133  in->NeedSYMBOLorNUMBER();
134  row->SetFullURI( in->FromUTF8() );
135  break;
136 
137  case T_type:
138  if( sawType )
139  in->Duplicate( tok );
140  sawType = true;
141  in->NeedSYMBOLorNUMBER();
142  row->SetType( in->FromUTF8() );
143  break;
144 
145  case T_options:
146  if( sawOpts )
147  in->Duplicate( tok );
148  sawOpts = true;
149  in->NeedSYMBOLorNUMBER();
150  row->SetOptions( in->FromUTF8() );
151  break;
152 
153  case T_descr:
154  if( sawDesc )
155  in->Duplicate( tok );
156  sawDesc = true;
157  in->NeedSYMBOLorNUMBER();
158  row->SetDescr( in->FromUTF8() );
159  break;
160 
161  default:
162  in->Unexpected( tok );
163  }
164 
165  in->NeedRIGHT();
166  }
167 
168  if( !sawType )
169  in->Expecting( T_type );
170 
171  if( !sawUri )
172  in->Expecting( T_uri );
173 
174  // all nickNames within this table fragment must be unique, so we do not
175  // use doReplace in InsertRow(). (However a fallBack table can have a
176  // conflicting nickName and ours will supercede that one since in
177  // FindLib() we search this table before any fall back.)
178  if( !InsertRow( row.release() ) )
179  {
180  wxString msg = wxString::Format(
181  _( "'%s' is a duplicate footprint library nickName" ),
182  GetChars( row->GetNickName() ) );
183  THROW_PARSE_ERROR( msg, in->CurSource(), in->CurLine(), lineNum, offset );
184  }
185  }
186 }
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_PARSE_ERROR(aProblem, aSource, aInputLine, aLineNumber, aByteIndex)
Definition: ki_exception.h:133
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 414 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().

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

209 {
210  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
211  wxASSERT( (PLUGIN*) row->plugin );
212  row->plugin->PrefetchLib( row->GetFullURI( true ), row->GetProperties() );
213 }
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 489 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().

490  {
491  nickIndex.clear();
492 
493  for( LIB_TABLE_ROWS_ITER it = rows.begin(); it != rows.end(); ++it )
494  nickIndex.insert( INDEX_VALUE( it->GetNickName(), it - rows.begin() ) );
495  }
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
throw ( IO_ERROR,
boost::interprocess::lock_exception
)
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 Format().

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

375 {
376  FILE_OUTPUTFORMATTER sf( aFileName );
377  Format( &sf, 0 );
378 }
virtual void Format(OUTPUTFORMATTER *aOutput, int aIndentLevel) const =0
Function Format.
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 515 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: