KiCad PCB EDA Suite
FP_TBL_MODEL Class Reference

Class FP_TBL_MODEL mixes in FP_LIB_TABLE into wxGridTableBase so the result can be used as a table within wxGrid. More...

Inheritance diagram for FP_TBL_MODEL:
FP_LIB_TABLE LIB_TABLE PROJECT::_ELEM

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

 FP_TBL_MODEL (const FP_LIB_TABLE &aTableToEdit)
 Constructor FP_TBL_MODEL is a copy constructor that builds a wxGridTableBase (table model) by wrapping an FP_LIB_TABLE. More...
 
int GetNumberRows () override
 
int GetNumberCols () override
 
wxString GetValue (int aRow, int aCol) override
 
void SetValue (int aRow, int aCol, const wxString &aValue) override
 
bool IsEmptyCell (int aRow, int aCol) override
 
bool InsertRows (size_t aPos=0, size_t aNumRows=1) override
 
bool AppendRows (size_t aNumRows=1) override
 
bool DeleteRows (size_t aPos, size_t aNumRows) override
 
wxString GetColLabelValue (int aCol) override
 
virtual void Parse (LIB_TABLE_LEXER *aLexer) override
 Function Parse. More...
 
virtual void Format (OUTPUTFORMATTER *aOutput, int aIndentLevel) const override
 Function Format. 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...
 
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...
 

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 boost::ptr_vector< LIB_TABLE_ROWLIB_TABLE_ROWS
 
typedef LIB_TABLE_ROWS::iterator LIB_TABLE_ROWS_ITER
 
typedef LIB_TABLE_ROWS::const_iterator LIB_TABLE_ROWS_CITER
 
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_GRID_TRICKS
 

Detailed Description

Class FP_TBL_MODEL mixes in FP_LIB_TABLE into wxGridTableBase so the result can be used as a table within wxGrid.

Definition at line 66 of file dialog_fp_lib_table.cpp.

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

typedef INDEX::const_iterator LIB_TABLE::INDEX_CITER
protectedinherited

Definition at line 497 of file lib_table_base.h.

typedef INDEX::iterator LIB_TABLE::INDEX_ITER
protectedinherited

Definition at line 496 of file lib_table_base.h.

typedef INDEX::value_type LIB_TABLE::INDEX_VALUE
protectedinherited

Definition at line 498 of file lib_table_base.h.

typedef boost::ptr_vector< LIB_TABLE_ROW > LIB_TABLE::LIB_TABLE_ROWS
protectedinherited

Definition at line 488 of file lib_table_base.h.

typedef LIB_TABLE_ROWS::const_iterator LIB_TABLE::LIB_TABLE_ROWS_CITER
protectedinherited

Definition at line 490 of file lib_table_base.h.

typedef LIB_TABLE_ROWS::iterator LIB_TABLE::LIB_TABLE_ROWS_ITER
protectedinherited

Definition at line 489 of file lib_table_base.h.

Member Enumeration Documentation

enum FP_LIB_TABLE::SAVE_T
inherited

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

Enumerator
SAVE_OK 
SAVE_SKIPPED 

Definition at line 168 of file fp_lib_table.h.

Constructor & Destructor Documentation

FP_TBL_MODEL::FP_TBL_MODEL ( const FP_LIB_TABLE aTableToEdit)
inline

Constructor FP_TBL_MODEL is a copy constructor that builds a wxGridTableBase (table model) by wrapping an FP_LIB_TABLE.

Definition at line 77 of file dialog_fp_lib_table.cpp.

References LIB_TABLE::rows.

78  {
79  rows = aTableToEdit.rows;
80  }
LIB_TABLE_ROWS rows

Member Function Documentation

bool FP_TBL_MODEL::AppendRows ( size_t  aNumRows = 1)
inlineoverride

Definition at line 157 of file dialog_fp_lib_table.cpp.

References LIB_TABLE::rows.

Referenced by FP_GRID_TRICKS::paste_text().

158  {
159  // do not modify aNumRows, original value needed for wxGridTableMessage below
160  for( int i = aNumRows; i; --i )
161  rows.push_back( new FP_LIB_TABLE_ROW );
162 
163  if( GetView() )
164  {
165  wxGridTableMessage msg( this,
166  wxGRIDTABLE_NOTIFY_ROWS_APPENDED,
167  aNumRows );
168 
169  GetView()->ProcessTableMessage( msg );
170  }
171 
172  return true;
173  }
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:41
LIB_TABLE_ROWS rows
LIB_TABLE_ROW* LIB_TABLE::At ( int  aIndex)
inlineinherited

Definition at line 350 of file lib_table_base.h.

References LIB_TABLE::rows.

Referenced by FP_GRID_TRICKS::paste_text().

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

Delete all rows.

Definition at line 324 of file lib_table_base.h.

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

Referenced by DIALOG_FP_LIB_TABLE::onOKButtonClick().

325  {
326  rows.clear();
327  nickIndex.clear();
328  }
LIB_TABLE_ROWS rows
INDEX nickIndex
this particular key is the nickName within each row.
bool FP_TBL_MODEL::DeleteRows ( size_t  aPos,
size_t  aNumRows 
)
inlineoverride

Definition at line 175 of file dialog_fp_lib_table.cpp.

References LIB_TABLE::rows.

Referenced by DIALOG_FP_LIB_TABLE::verifyTables().

176  {
177  // aPos may be a large positive, e.g. size_t(-1), and the sum of
178  // aPos+aNumRows may wrap here, so both ends of the range are tested.
179  if( aPos < rows.size() && aPos + aNumRows <= rows.size() )
180  {
181  LIB_TABLE_ROWS_ITER start = rows.begin() + aPos;
182  rows.erase( start, start + aNumRows );
183 
184  if( GetView() )
185  {
186  wxGridTableMessage msg( this,
187  wxGRIDTABLE_NOTIFY_ROWS_DELETED,
188  aPos,
189  aNumRows );
190 
191  GetView()->ProcessTableMessage( msg );
192  }
193 
194  return true;
195  }
196 
197  return false;
198  }
LIB_TABLE_ROWS rows
LIB_TABLE_ROWS::iterator LIB_TABLE_ROWS_ITER
void LIB_TABLE::ensureIndex ( )
inlineprotectedinherited

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

480  {
481  // The dialog lib table editor may not maintain the nickIndex.
482  // Lazy indexing may be required. To handle lazy indexing, we must enforce
483  // that "nickIndex" is either empty or accurate, but never inaccurate.
484  if( !nickIndex.size() )
485  reindex();
486  }
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 480 of file lib_table_base.cpp.

References ExpandEnvVarSubstitutions().

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

481 {
482  return ExpandEnvVarSubstitutions( aString );
483 }
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
)
inherited

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 207 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 FP_LIB_TABLE::FootprintDelete(), FP_LIB_TABLE::FootprintEnumerate(), FP_LIB_TABLE::FootprintLibCreate(), FP_LIB_TABLE::FootprintLibDelete(), FP_LIB_TABLE::FootprintLoad(), FP_LIB_TABLE::FootprintSave(), FP_LIB_TABLE::IsFootprintLibWritable(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), and FOOTPRINT_EDIT_FRAME::updateTitle().

209 {
210  FP_LIB_TABLE_ROW* row = dynamic_cast< FP_LIB_TABLE_ROW* >( findRow( aNickname ) );
211 
212  if( !row )
213  {
214  wxString msg = wxString::Format(
215  _( "fp-lib-table files contain no library with nickname '%s'" ),
216  GetChars( aNickname ) );
217 
218  THROW_IO_ERROR( msg );
219  }
220 
221  // We've been 'lazy' up until now, but it cannot be deferred any longer,
222  // instantiate a PLUGIN of the proper kind if it is not already in this
223  // FP_LIB_TABLE_ROW.
224  if( !row->plugin )
225  row->setPlugin( IO_MGR::PluginFind( row->type ) );
226 
227  return row;
228 }
void setPlugin(PLUGIN *aPlugin)
Definition: fp_lib_table.h:92
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:41
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:97
#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 
)
inherited

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

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

289 {
290  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
291  wxASSERT( (PLUGIN*) row->plugin );
292  return row->plugin->FootprintDelete( row->GetFullURI( true ), aFootprintName,
293  row->GetProperties() );
294 }
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:41
const PROPERTIES * GetProperties() const
Function GetProperties.
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:97
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:85
wxArrayString FP_LIB_TABLE::FootprintEnumerate ( const wxString &  aNickname)
inherited

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

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

Referenced by guessNickname(), and FOOTPRINT_LIST::loader_job().

200 {
201  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
202  wxASSERT( (PLUGIN*) row->plugin );
203  return row->plugin->FootprintEnumerate( row->GetFullURI( true ), row->GetProperties() );
204 }
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:41
const PROPERTIES * GetProperties() const
Function GetProperties.
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:97
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)
inherited

Definition at line 313 of file fp_lib_table.cpp.

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

314 {
315  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
316  wxASSERT( (PLUGIN*) row->plugin );
317  row->plugin->FootprintLibCreate( row->GetFullURI( true ), row->GetProperties() );
318 }
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:41
const PROPERTIES * GetProperties() const
Function GetProperties.
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:97
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:92
void FP_LIB_TABLE::FootprintLibDelete ( const wxString &  aNickname)
inherited

Definition at line 305 of file fp_lib_table.cpp.

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

306 {
307  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
308  wxASSERT( (PLUGIN*) row->plugin );
309  row->plugin->FootprintLibDelete( row->GetFullURI( true ), row->GetProperties() );
310 }
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:41
const PROPERTIES * GetProperties() const
Function GetProperties.
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:97
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:99
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 
)
inherited

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

References FP_LIB_TABLE::FindRow(), PLUGIN::FootprintLoad(), 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, and LIB_ID::SetLibNickname().

Referenced by FOOTPRINT_INFO::load(), and FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary().

232 {
233  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
234  wxASSERT( (PLUGIN*) row->plugin );
235 
236  MODULE* ret = row->plugin->FootprintLoad( row->GetFullURI( true ), aFootprintName,
237  row->GetProperties() );
238 
239  // The library cannot know its own name, because it might have been renamed or moved.
240  // Therefore footprints cannot know their own library nickname when residing in
241  // a footprint library.
242  // Only at this API layer can we tell the footprint about its actual library nickname.
243  if( ret )
244  {
245  // remove "const"-ness, I really do want to set nickname without
246  // having to copy the LIB_ID and its two strings, twice each.
247  LIB_ID& fpid = (LIB_ID&) ret->GetFPID();
248 
249  // Catch any misbehaving plugin, which should be setting internal footprint name properly:
250  wxASSERT( aFootprintName == (wxString) fpid.GetLibItemName() );
251 
252  // and clearing nickname
253  wxASSERT( !fpid.GetLibNickname().size() );
254 
255  fpid.SetLibNickname( row->GetNickName() );
256  }
257 
258  return ret;
259 }
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:41
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:97
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:69
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
)
inherited

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

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

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

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

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

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

264 {
265  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
266  wxASSERT( (PLUGIN*) row->plugin );
267 
268  if( !aOverwrite )
269  {
270  // Try loading the footprint to see if it already exists, caller wants overwrite
271  // protection, which is atypical, not the default.
272 
273  wxString fpname = aFootprint->GetFPID().GetLibItemName();
274 
275  std::unique_ptr<MODULE> footprint( row->plugin->FootprintLoad( row->GetFullURI( true ),
276  fpname, row->GetProperties() ) );
277 
278  if( footprint.get() )
279  return SAVE_SKIPPED;
280  }
281 
282  row->plugin->FootprintSave( row->GetFullURI( true ), aFootprint, row->GetProperties() );
283 
284  return SAVE_OK;
285 }
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:41
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:78
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:97
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:69
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
overridevirtualinherited

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

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

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

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

References OPT_SEP.

Referenced by DIALOG_FP_PLUGIN_OPTIONS::makeResult().

443 {
444  UTF8 ret;
445 
446  if( aProperties )
447  {
448  for( PROPERTIES::const_iterator it = aProperties->begin(); it != aProperties->end(); ++it )
449  {
450  const std::string& name = it->first;
451 
452  const UTF8& value = it->second;
453 
454  if( ret.size() )
455  ret += OPT_SEP;
456 
457  ret += name;
458 
459  // the separation between name and value is '='
460  if( value.size() )
461  {
462  ret += '=';
463 
464  for( std::string::const_iterator si = value.begin(); si != value.end(); ++si )
465  {
466  // escape any separator in the value.
467  if( *si == OPT_SEP )
468  ret += '\\';
469 
470  ret += *si;
471  }
472  }
473  }
474  }
475 
476  return ret;
477 }
Class UTF8 is an 8 bit std::string that is assuredly encoded in UTF8, and supplies special conversion...
Definition: utf8.h:53
#define OPT_SEP
options separator character
wxString FP_TBL_MODEL::GetColLabelValue ( int  aCol)
inlineoverride

Definition at line 200 of file dialog_fp_lib_table.cpp.

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

201  {
202  switch( aCol )
203  {
204  case COL_NICKNAME: return _( "Nickname" );
205  case COL_URI: return _( "Library Path" );
206 
207  // keep this "Plugin Type" text fairly long so column is sized wide enough
208  case COL_TYPE: return _( "Plugin Type" );
209  case COL_OPTIONS: return _( "Options" );
210  case COL_DESCR: return _( "Description" );
211  default: return wxEmptyString;
212  }
213  }
int LIB_TABLE::GetCount ( )
inlineinherited

Definition at line 348 of file lib_table_base.h.

References LIB_TABLE::rows.

Referenced by FP_GRID_TRICKS::paste_text().

348 { 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.
wxString FP_LIB_TABLE::GetGlobalTableFileName ( )
staticinherited

Function GetGlobalTableFileName.

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

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

395 {
396  wxFileName fn;
397 
398  fn.SetPath( GetKicadConfigPath() );
399  fn.SetName( global_tbl_name );
400 
401  return fn.GetFullPath();
402 }
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(), guessNickname(), CVPCB_MAINFRAME::LoadFootprintFiles(), FOOTPRINT_LIST::ReadFootprintFiles(), and PCB_BASE_FRAME::SelectLibrary().

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::const_iterator LIB_TABLE_ROWS_CITER
LIB_TABLE_ROWS rows
LIB_TABLE * fallBack
Class LIB_TABLE.
int FP_TBL_MODEL::GetNumberCols ( )
inlineoverride

Definition at line 85 of file dialog_fp_lib_table.cpp.

References COL_COUNT.

85 { return COL_COUNT; }
wxString FP_TBL_MODEL::GetValue ( int  aRow,
int  aCol 
)
inlineoverride

Definition at line 87 of file dialog_fp_lib_table.cpp.

References COL_DESCR, COL_NICKNAME, COL_OPTIONS, COL_TYPE, COL_URI, LIB_TABLE_ROW::GetDescr(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE_ROW::GetOptions(), LIB_TABLE_ROW::GetType(), and LIB_TABLE::rows.

Referenced by IsEmptyCell(), DIALOG_FP_LIB_TABLE::populateEnvironReadOnlyTable(), and DIALOG_FP_LIB_TABLE::verifyTables().

88  {
89  if( unsigned( aRow ) < rows.size() )
90  {
91  const LIB_TABLE_ROW* r = &rows[aRow];
92 
93  switch( aCol )
94  {
95  case COL_NICKNAME: return r->GetNickName();
96  case COL_URI: return r->GetFullURI();
97  case COL_TYPE: return r->GetType();
98  case COL_OPTIONS: return r->GetOptions();
99  case COL_DESCR: return r->GetDescr();
100  default:
101  ; // fall thru to wxEmptyString
102  }
103  }
104 
105  return wxEmptyString;
106  }
Class LIB_TABLE_ROW.
const wxString & GetOptions() const
Function GetOptions.
LIB_TABLE_ROWS rows
virtual const wxString GetType() const =0
Function GetType.
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
const wxString & GetDescr() const
Function GetDescr.
const wxString & GetNickName() const
Function GetNickName.
const wxString FP_LIB_TABLE::GlobalPathEnvVariableName ( )
staticinherited

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

354 {
355  return "KISYSMOD";
356 }
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 InvokeFootprintWizard(), SYMBOL_LIB_TABLE::Parse(), and FP_LIB_TABLE::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 FP_TBL_MODEL::InsertRows ( size_t  aPos = 0,
size_t  aNumRows = 1 
)
inlineoverride

Definition at line 130 of file dialog_fp_lib_table.cpp.

References LIB_TABLE::rows.

131  {
132  if( aPos < rows.size() )
133  {
134  for( size_t i = 0; i < aNumRows; i++ )
135  {
136  rows.insert( rows.begin() + i,
137  dynamic_cast< LIB_TABLE_ROW* >( new FP_LIB_TABLE_ROW ) );
138  }
139 
140  // use the (wxGridStringTable) source Luke.
141  if( GetView() )
142  {
143  wxGridTableMessage msg( this,
144  wxGRIDTABLE_NOTIFY_ROWS_INSERTED,
145  aPos,
146  aNumRows );
147 
148  GetView()->ProcessTableMessage( msg );
149  }
150 
151  return true;
152  }
153 
154  return false;
155  }
Class LIB_TABLE_ROW.
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:41
LIB_TABLE_ROWS rows
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(), 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_TBL_MODEL::IsEmptyCell ( int  aRow,
int  aCol 
)
inlineoverride

Definition at line 125 of file dialog_fp_lib_table.cpp.

References GetValue().

126  {
127  return !GetValue( aRow, aCol );
128  }
wxString GetValue(int aRow, int aCol) override
bool FP_LIB_TABLE::IsFootprintLibWritable ( const wxString &  aNickname)
inherited

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

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

298 {
299  const FP_LIB_TABLE_ROW* row = FindRow( aNickname );
300  wxASSERT( (PLUGIN*) row->plugin );
301  return row->plugin->IsFootprintLibWritable( row->GetFullURI( true ) );
302 }
Class FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:41
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
PLUGIN::RELEASER plugin
Definition: fp_lib_table.h:97
virtual bool IsFootprintLibWritable(const wxString &aLibraryPath)
Function IsFootprintLibWritable returns true iff the library at aLibraryPath is writable.
Definition: plugin.cpp:107
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.

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
)
staticinherited

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

361 {
362  bool tableExists = true;
363  wxFileName fn = GetGlobalTableFileName();
364 
365  if( !fn.FileExists() )
366  {
367  tableExists = false;
368 
369  if( !fn.DirExists() && !fn.Mkdir( 0x777, wxPATH_MKDIR_FULL ) )
370  {
371  THROW_IO_ERROR( wxString::Format( _( "Cannot create global library table path '%s'." ),
372  GetChars( fn.GetPath() ) ) );
373  }
374 
375  // Attempt to copy the default global file table from the KiCad
376  // template folder to the user's home configuration path.
377  wxString fileName = Kiface().KifaceSearch().FindValidPath( global_tbl_name );
378 
379  // The fallback is to create an empty global footprint table for the user to populate.
380  if( fileName.IsEmpty() || !::wxCopyFile( fileName, fn.GetFullPath(), false ) )
381  {
382  FP_LIB_TABLE emptyTable;
383 
384  emptyTable.Save( fn.GetFullPath() );
385  }
386  }
387 
388  aTable.Load( fn.GetFullPath() );
389 
390  return tableExists;
391 }
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 346 of file lib_table_base.h.

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

Definition at line 330 of file lib_table_base.h.

References LIB_TABLE::rows.

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

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

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

References OPT_SEP.

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

382 {
383  if( aOptionsList.size() )
384  {
385  const char* cp = &aOptionsList[0];
386  const char* end = cp + aOptionsList.size();
387 
388  PROPERTIES props;
389  std::string pair;
390 
391  // Parse all name=value pairs
392  while( cp < end )
393  {
394  pair.clear();
395 
396  // Skip leading white space.
397  while( cp < end && isspace( *cp ) )
398  ++cp;
399 
400  // Find the end of pair/field
401  while( cp < end )
402  {
403  if( *cp == '\\' && cp + 1 < end && cp[1] == OPT_SEP )
404  {
405  ++cp; // skip the escape
406  pair += *cp++; // add the separator
407  }
408  else if( *cp == OPT_SEP )
409  {
410  ++cp; // skip the separator
411  break; // process the pair
412  }
413  else
414  pair += *cp++;
415  }
416 
417  // stash the pair
418  if( pair.size() )
419  {
420  // first equals sign separates 'name' and 'value'.
421  size_t eqNdx = pair.find( '=' );
422 
423  if( eqNdx != pair.npos )
424  {
425  std::string name = pair.substr( 0, eqNdx );
426  std::string value = pair.substr( eqNdx + 1 );
427  props[name] = value;
428  }
429  else
430  props[pair] = ""; // property is present, but with no value.
431  }
432  }
433 
434  if( props.size() )
435  return new PROPERTIES( props );
436  }
437 
438  return NULL;
439 }
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
#define OPT_SEP
options separator character
void LIB_TABLE::reindex ( )
inlineprotectedinherited

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

472  {
473  nickIndex.clear();
474 
475  for( LIB_TABLE_ROWS_ITER it = rows.begin(); it != rows.end(); ++it )
476  nickIndex.insert( INDEX_VALUE( it->GetNickName(), it - rows.begin() ) );
477  }
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 FP_LIB_TABLE::LoadGlobalTable(), SYMBOL_LIB_TABLE::LoadGlobalTable(), and CVPCB_MAINFRAME::OnEditFootprintLibraryTable().

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
void FP_TBL_MODEL::SetValue ( int  aRow,
int  aCol,
const wxString &  aValue 
)
inlineoverride

Definition at line 108 of file dialog_fp_lib_table.cpp.

References COL_DESCR, COL_NICKNAME, COL_OPTIONS, COL_TYPE, COL_URI, LIB_TABLE::rows, LIB_TABLE_ROW::SetDescr(), LIB_TABLE_ROW::SetFullURI(), LIB_TABLE_ROW::SetNickName(), LIB_TABLE_ROW::SetOptions(), and LIB_TABLE_ROW::SetType().

Referenced by DIALOG_FP_LIB_TABLE::OnClickLibraryWizard(), and DIALOG_FP_LIB_TABLE::verifyTables().

109  {
110  if( unsigned( aRow ) < rows.size() )
111  {
112  LIB_TABLE_ROW* r = &rows[aRow];
113 
114  switch( aCol )
115  {
116  case COL_NICKNAME: r->SetNickName( aValue ); break;
117  case COL_URI: r->SetFullURI( aValue ); break;
118  case COL_TYPE: r->SetType( aValue ); break;
119  case COL_OPTIONS: r->SetOptions( aValue ); break;
120  case COL_DESCR: r->SetDescr( aValue ); break;
121  }
122  }
123  }
Class LIB_TABLE_ROW.
virtual void SetType(const wxString &aType)=0
Function SetType.
LIB_TABLE_ROWS rows
void SetFullURI(const wxString &aFullURI)
Function SetFullURI.
void SetNickName(const wxString &aNickName)
Function SetNickName.
void SetOptions(const wxString &aOptions)
Function SetOptions.
void SetDescr(const wxString &aDescr)
Function SetDescr.

Friends And Related Function Documentation

friend class FP_GRID_TRICKS
friend

Definition at line 68 of file dialog_fp_lib_table.cpp.

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 501 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 file: