KiCad PCB EDA Suite
SYMBOL_LIB_TABLE Class Reference

#include <symbol_lib_table.h>

Inheritance diagram for SYMBOL_LIB_TABLE:
LIB_TABLE PROJECT::_ELEM

Public Types

enum  SAVE_T { SAVE_OK, SAVE_SKIPPED }
 Enum SAVE_T. 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...
 
 SYMBOL_LIB_TABLE (SYMBOL_LIB_TABLE *aFallBackTable=NULL)
 Constructor SYMBOL_LIB_TABLE. More...
 
const SYMBOL_LIB_TABLE_ROWFindRow (const wxString &aNickName) throw ( IO_ERROR )
 Function FindRow. More...
 
void EnumerateSymbolLib (const wxString &aNickname, wxArrayString &aAliasNames)
 Function EnumerateSymbolLib. More...
 
LIB_ALIASLoadSymbol (const wxString &aNickname, const wxString &aAliasName)
 Function LoadSymbol. More...
 
SAVE_T SaveSymbol (const wxString &aNickname, const LIB_PART *aSymbol, bool aOverwrite=true)
 Function SaveSymbol. More...
 
void DeleteSymbol (const wxString &aNickname, const wxString &aSymboltName)
 Function DeleteSymbol. More...
 
void DeleteAlias (const wxString &aNickname, const wxString &aAliasName)
 Function DeleteAlias. More...
 
bool IsSymbolLibWritable (const wxString &aNickname)
 Function IsSymbolLibWritable. More...
 
void DeleteSymbolLib (const wxString &aNickname)
 
void CreateSymbolLib (const wxString &aNickname)
 
LIB_ALIASLoadSymbolWithOptionalNickname (const LIB_ID &aId) throw ( IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception )
 Function LoadSymboldWithOptionalNickname loads a LIB_PART having aFootprintId with possibly an empty librarynickname. 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 (SYMBOL_LIB_TABLE &aTable) throw (IO_ERROR, PARSE_ERROR, boost::interprocess::lock_exception )
 Function LoadGlobalTable. More...
 
static wxString GetGlobalTableFileName ()
 Function GetGlobalTableFileName. More...
 
static const wxString GlobalPathEnvVariableName ()
 Function GlobalPathEnvVarVariableName. More...
 
static SYMBOL_LIB_TABLEGetGlobalLibTable ()
 
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
 

Static Private Attributes

static SYMBOL_LIB_TABLE m_globalLibTable
 

Detailed Description

Definition at line 100 of file symbol_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 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 SAVE_T.

is the set of return values from SaveSymbol() below.

Enumerator
SAVE_OK 
SAVE_SKIPPED 

Definition at line 167 of file symbol_lib_table.h.

Constructor & Destructor Documentation

SYMBOL_LIB_TABLE::SYMBOL_LIB_TABLE ( SYMBOL_LIB_TABLE aFallBackTable = NULL)

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

Definition at line 61 of file symbol_lib_table.cpp.

61  :
62  LIB_TABLE( aFallBackTable )
63 {
64  // not copying fall back, simply search aFallBackTable separately
65  // if "nickName not found".
66 }
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 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.
void SYMBOL_LIB_TABLE::CreateSymbolLib ( const wxString &  aNickname)

Definition at line 325 of file symbol_lib_table.cpp.

References SCH_PLUGIN::CreateSymbolLib(), FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetProperties(), and SYMBOL_LIB_TABLE_ROW::plugin.

326 {
327  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
328  wxASSERT( (SCH_PLUGIN*) row->plugin );
329  row->plugin->CreateSymbolLib( row->GetFullURI( true ), row->GetProperties() );
330 }
virtual void CreateSymbolLib(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL)
Function CreateSymbolLib.
Definition: sch_plugin.cpp:134
Class SYMBOL_LIB_TABLE_ROW.
const SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
const PROPERTIES * GetProperties() const
Function GetProperties.
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
Class SCH_PLUGIN is a base class that SCHEMATIC loading and saving plugins should derive from...
Definition: sch_io_mgr.h:187
void SYMBOL_LIB_TABLE::DeleteAlias ( const wxString &  aNickname,
const wxString &  aAliasName 
)

Function DeleteAlias.

deletes aAliasName from the library at aLibraryPath.

If aAliasName refers the the root LIB_PART object, the part is renamed to the next or previous LIB_ALIAS in the LIB_PART if one exists. If the LIB_ALIAS is the last alias referring to the root LIB_PART, the LIB_PART is also removed from the library.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW
aAliasNameis the name of a LIB_ALIAS to delete from the specified library.
Exceptions
IO_ERRORif there is a problem finding the alias or the library or deleting it.

Definition at line 300 of file symbol_lib_table.cpp.

References SCH_PLUGIN::DeleteAlias(), FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetProperties(), and SYMBOL_LIB_TABLE_ROW::plugin.

301 {
302  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
303  wxASSERT( (SCH_PLUGIN*) row->plugin );
304  return row->plugin->DeleteAlias( row->GetFullURI( true ), aAliasName,
305  row->GetProperties() );
306 }
Class SYMBOL_LIB_TABLE_ROW.
const SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
const PROPERTIES * GetProperties() const
Function GetProperties.
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
Class SCH_PLUGIN is a base class that SCHEMATIC loading and saving plugins should derive from...
Definition: sch_io_mgr.h:187
virtual void DeleteAlias(const wxString &aLibraryPath, const wxString &aAliasName, const PROPERTIES *aProperties=NULL)
Function DeleteAlias.
Definition: sch_plugin.cpp:118
void SYMBOL_LIB_TABLE::DeleteSymbol ( const wxString &  aNickname,
const wxString &  aSymboltName 
)

Function DeleteSymbol.

deletes the aSymbolName from the library given by aNickname.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW.
aSymbolNameis the name of a symbol to delete from the specified library.
Exceptions
IO_ERRORif there is a problem finding the footprint or the library, or deleting it.

Definition at line 291 of file symbol_lib_table.cpp.

References SCH_PLUGIN::DeleteSymbol(), FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetProperties(), and SYMBOL_LIB_TABLE_ROW::plugin.

292 {
293  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
294  wxASSERT( (SCH_PLUGIN*) row->plugin );
295  return row->plugin->DeleteSymbol( row->GetFullURI( true ), aSymbolName,
296  row->GetProperties() );
297 }
Class SYMBOL_LIB_TABLE_ROW.
const SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
const PROPERTIES * GetProperties() const
Function GetProperties.
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
virtual void DeleteSymbol(const wxString &aLibraryPath, const wxString &aAliasName, const PROPERTIES *aProperties=NULL)
Function DeleteSymbol.
Definition: sch_plugin.cpp:126
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
Class SCH_PLUGIN is a base class that SCHEMATIC loading and saving plugins should derive from...
Definition: sch_io_mgr.h:187
void SYMBOL_LIB_TABLE::DeleteSymbolLib ( const wxString &  aNickname)

Definition at line 317 of file symbol_lib_table.cpp.

References SCH_PLUGIN::DeleteSymbolLib(), FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetProperties(), and SYMBOL_LIB_TABLE_ROW::plugin.

318 {
319  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
320  wxASSERT( (SCH_PLUGIN*) row->plugin );
321  row->plugin->DeleteSymbolLib( row->GetFullURI( true ), row->GetProperties() );
322 }
virtual bool DeleteSymbolLib(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL)
Function DeleteSymbolLib.
Definition: sch_plugin.cpp:141
Class SYMBOL_LIB_TABLE_ROW.
const SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
const PROPERTIES * GetProperties() const
Function GetProperties.
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
Class SCH_PLUGIN is a base class that SCHEMATIC loading and saving plugins should derive from...
Definition: sch_io_mgr.h:187
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.
void SYMBOL_LIB_TABLE::EnumerateSymbolLib ( const wxString &  aNickname,
wxArrayString &  aAliasNames 
)

Function EnumerateSymbolLib.

returns a list of symbol alias names contained within the library given by aNickname.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW.
aAliasNamesis a reference to an array for the alias names
Exceptions
IO_ERRORif the library cannot be found or loaded.

Definition at line 201 of file symbol_lib_table.cpp.

References SCH_PLUGIN::EnumerateSymbolLib(), FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetProperties(), and SYMBOL_LIB_TABLE_ROW::plugin.

202 {
203  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
204  wxASSERT( (SCH_PLUGIN*) row->plugin );
205  row->plugin->EnumerateSymbolLib( aAliasNames, row->GetFullURI( true ), row->GetProperties() );
206 }
Class SYMBOL_LIB_TABLE_ROW.
const SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
const PROPERTIES * GetProperties() const
Function GetProperties.
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
virtual void EnumerateSymbolLib(wxArrayString &aAliasNameList, const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL)
Function EnumerateSymbolLib.
Definition: sch_plugin.cpp:83
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
Class SCH_PLUGIN is a base class that SCHEMATIC loading and saving plugins should derive from...
Definition: sch_io_mgr.h:187
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 SYMBOL_LIB_TABLE_ROW * SYMBOL_LIB_TABLE::FindRow ( const wxString &  aNickName)
throw (IO_ERROR
)

Function FindRow.

returns an SYMBOL_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 SYMBOL_LIB_TABLE_ROW if not already loaded.

Exceptions
IO_ERRORif aNickName cannot be found.

Definition at line 209 of file symbol_lib_table.cpp.

References SCH_IO_MGR::FindPlugin(), Format(), GetChars(), SYMBOL_LIB_TABLE_ROW::plugin, SYMBOL_LIB_TABLE_ROW::setPlugin(), THROW_IO_ERROR, and SYMBOL_LIB_TABLE_ROW::type.

Referenced by CreateSymbolLib(), DeleteAlias(), DeleteSymbol(), DeleteSymbolLib(), EnumerateSymbolLib(), IsSymbolLibWritable(), LoadSymbol(), and SaveSymbol().

211 {
212  SYMBOL_LIB_TABLE_ROW* row = dynamic_cast< SYMBOL_LIB_TABLE_ROW* >( findRow( aNickname ) );
213 
214  if( !row )
215  {
216  wxString msg = wxString::Format(
217  _( "sym-lib-table files contain no library with nickname '%s'" ),
218  GetChars( aNickname ) );
219 
220  THROW_IO_ERROR( msg );
221  }
222 
223  // We've been 'lazy' up until now, but it cannot be deferred any longer,
224  // instantiate a PLUGIN of the proper kind if it is not already in this
225  // SYMBOL_LIB_TABLE_ROW.
226  if( !row->plugin )
227  row->setPlugin( SCH_IO_MGR::FindPlugin( row->type ) );
228 
229  return row;
230 }
Class SYMBOL_LIB_TABLE_ROW.
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
static SCH_PLUGIN * FindPlugin(SCH_FILE_T aFileType)
Function FindPlugin returns a SCH_PLUGIN which the caller can use to import, export, save, or load design documents.
Definition: sch_io_mgr.cpp:48
#define THROW_IO_ERROR(x)
Definition: utf8.cpp:60
void setPlugin(SCH_PLUGIN *aPlugin)
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
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 SYMBOL_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 190 of file symbol_lib_table.cpp.

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

191 {
192  aOutput->Print( aIndentLevel, "(sym_lib_table\n" );
193 
194  for( LIB_TABLE_ROWS_CITER it = rows.begin(); it != rows.end(); ++it )
195  it->Format( aOutput, aIndentLevel+1 );
196 
197  aOutput->Print( aIndentLevel, ")\n" );
198 }
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
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.
static SYMBOL_LIB_TABLE& SYMBOL_LIB_TABLE::GetGlobalLibTable ( )
inlinestatic

Definition at line 293 of file symbol_lib_table.h.

References m_globalLibTable.

Referenced by SCH::IFACE::OnKifaceStart().

293 { return m_globalLibTable; }
static SYMBOL_LIB_TABLE m_globalLibTable
wxString SYMBOL_LIB_TABLE::GetGlobalTableFileName ( )
static

Function GetGlobalTableFileName.

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

Definition at line 406 of file symbol_lib_table.cpp.

References GetKicadConfigPath(), and global_tbl_name.

407 {
408  wxFileName fn;
409 
410  fn.SetPath( GetKicadConfigPath() );
411  fn.SetName( global_tbl_name );
412 
413  return fn.GetFullPath();
414 }
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_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::const_iterator LIB_TABLE_ROWS_CITER
LIB_TABLE_ROWS rows
LIB_TABLE * fallBack
Class LIB_TABLE.
const wxString SYMBOL_LIB_TABLE::GlobalPathEnvVariableName ( )
static

Function GlobalPathEnvVarVariableName.

returns the name of the environment variable used to hold the directory of locally installed "KiCad sponsored" system symbol libraries. These can be either legacy or sweet format. The only thing special about this particular environment variable is that it is set automatically by KiCad on program start up, if it is not set already in the environment.

Definition at line 365 of file symbol_lib_table.cpp.

366 {
367  return "KICAD_SYSTEM_SYMBOLS";
368 }
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(), 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 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 SYMBOL_LIB_TABLE::IsSymbolLibWritable ( const wxString &  aNickname)

Function IsSymbolLibWritable.

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 aNickname exists.

Definition at line 309 of file symbol_lib_table.cpp.

References FindRow(), LIB_TABLE_ROW::GetFullURI(), SCH_PLUGIN::IsSymbolLibWritable(), and SYMBOL_LIB_TABLE_ROW::plugin.

310 {
311  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
312  wxASSERT( (SCH_PLUGIN*) row->plugin );
313  return row->plugin->IsSymbolLibWritable( row->GetFullURI( true ) );
314 }
Class SYMBOL_LIB_TABLE_ROW.
const SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
Class SCH_PLUGIN is a base class that SCHEMATIC loading and saving plugins should derive from...
Definition: sch_io_mgr.h:187
virtual bool IsSymbolLibWritable(const wxString &aLibraryPath)
Function IsSymbolLibWritable returns true if the library at aLibraryPath is writable.
Definition: sch_plugin.cpp:149
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 SYMBOL_LIB_TABLE::LoadGlobalTable ( SYMBOL_LIB_TABLE aTable)
throw (IO_ERROR,
PARSE_ERROR,
boost::interprocess::lock_exception
)
static

Function LoadGlobalTable.

loads the global symbol library table into aTable.

This probably should be move into the application object when KiCad is changed to a single process application. This is the least painful solution for the time being.

Parameters
aTablethe SYMBOL_LIB_TABLE object to load.
Returns
true if the global library table exists and is loaded properly.
Exceptions
IO_ERRORif an error occurs attempting to load the symbol library table.

Definition at line 371 of file symbol_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 SCH::IFACE::OnKifaceStart().

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

Function LoadSymbol.

loads a LIB_ALIAS having aAliasName from the library given by aNickname. The actual symbol can be retreaved from the LIB_ALIAS::GetPart() method.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW
aAliasNameis the name of the LIB_ALIAS to load.
Returns
LIB_ALIAS* - if found we own it, else NULL if not found.
Exceptions
IO_ERRORif the library cannot be found or read. No exception is thrown in the case where aAliasName cannot be found.

Definition at line 233 of file symbol_lib_table.cpp.

References FindRow(), FROM_UTF8(), LIB_TABLE_ROW::GetFullURI(), LIB_PART::GetLibId(), LIB_TABLE_ROW::GetNickName(), LIB_ALIAS::GetPart(), LIB_TABLE_ROW::GetProperties(), SCH_PLUGIN::LoadSymbol(), SYMBOL_LIB_TABLE_ROW::plugin, and TO_UTF8.

234 {
235  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
236  wxASSERT( (SCH_PLUGIN*) row->plugin );
237 
238  LIB_ALIAS* ret = row->plugin->LoadSymbol( row->GetFullURI( true ), aAliasName,
239  row->GetProperties() );
240 
241  // The library cannot know its own name, because it might have been renamed or moved.
242  // Therefore footprints cannot know their own library nickname when residing in
243  // a symbol library.
244  // Only at this API layer can we tell the symbol about its actual library nickname.
245  if( ret )
246  {
247  // remove "const"-ness, I really do want to set nickname without
248  // having to copy the LIB_ID and its two strings, twice each.
249  LIB_ID& id = (LIB_ID&) ret->GetPart()->GetLibId();
250 
251  // Catch any misbehaving plugin, which should be setting internal alias name properly:
252  wxASSERT( aAliasName == FROM_UTF8( id.GetLibItemName() ) );
253 
254  // and clearing nickname
255  wxASSERT( !id.GetLibNickname().size() );
256 
257  id.SetLibNickname( TO_UTF8( row->GetNickName() ) );
258  }
259 
260  return ret;
261 }
Part library alias object definition.
virtual LIB_ALIAS * LoadSymbol(const wxString &aLibraryPath, const wxString &aAliasName, const PROPERTIES *aProperties=NULL)
Function LoadSymbol.
Definition: sch_plugin.cpp:101
Class SYMBOL_LIB_TABLE_ROW.
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
const SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
const PROPERTIES * GetProperties() const
Function GetProperties.
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
const LIB_ID & GetLibId() const
Class LIB_ID.
Definition: lib_id.h:56
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
#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
Class SCH_PLUGIN is a base class that SCHEMATIC loading and saving plugins should derive from...
Definition: sch_io_mgr.h:187
LIB_PART * GetPart() const
Function GetPart gets the shared LIB_PART.
const wxString & GetNickName() const
Function GetNickName.
LIB_ALIAS * SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname ( const LIB_ID aId)
throw ( IO_ERROR,
PARSE_ERROR,
boost::interprocess::lock_exception
)

Function LoadSymboldWithOptionalNickname loads a LIB_PART having aFootprintId with possibly an empty librarynickname.

Parameters
aIdthe library nickname and name of the symbol to load.
Returns
LIB_PART* - if found the library 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 aId cannot be found.
PARSE_ERRORif atId is not parsed OK.

Definition at line 333 of file symbol_lib_table.cpp.

References FROM_UTF8().

335 {
336  wxString nickname = FROM_UTF8( aLibId.GetLibNickname() );
337  wxString name = FROM_UTF8( aLibId.GetLibItemName() );
338 
339  if( nickname.size() )
340  {
341  return LoadSymbol( nickname, name );
342  }
343 
344  // nickname is empty, sequentially search (alphabetically) all libs/nicks for first match:
345  else
346  {
347  std::vector<wxString> nicks = GetLogicalLibs();
348 
349  // Search each library going through libraries alphabetically.
350  for( unsigned i = 0; i < nicks.size(); ++i )
351  {
352  // FootprintLoad() returns NULL on not found, does not throw exception
353  // unless there's an IO_ERROR.
354  LIB_ALIAS* ret = LoadSymbol( nicks[i], name );
355 
356  if( ret )
357  return ret;
358  }
359 
360  return NULL;
361  }
362 }
LIB_ALIAS * LoadSymbol(const wxString &aNickname, const wxString &aAliasName)
Function LoadSymbol.
Part library alias object definition.
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
std::vector< wxString > GetLogicalLibs()
Function GetLogicalLibs.
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 SYMBOL_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 69 of file symbol_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, DSN::T_LEFT, FP_LIB_TABLE_T::T_lib, TLIB_T::T_name, FP_LIB_TABLE_T::T_options, DSN::T_RIGHT, FP_LIB_TABLE_T::T_sym_lib_table, DSN::T_type, FP_LIB_TABLE_T::T_uri, THROW_PARSE_ERROR, and DSNLEXER::Unexpected().

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

Function SaveSymbol.

will write aSymbol to an existing library given by aNickname. If a LIB_PART by the same name already exists or there are any conflicting alias names, the new LIB_PART will silently overwrite any existing aliases and/or part becaue libraries cannot have duplicate alias names. It is the responsibility of the caller to check the library for conflicts before saving.

Parameters
aNicknameis a locator for the "library", it is a "name" in LIB_TABLE_ROW
aSymbolis what to store in the library. The library owns the symbol after this call.
aOverwritewhen true means overwrite any existing symbol by the same name, else if false means skip the write and return SAVE_SKIPPED.
Returns
SAVE_T - SAVE_OK or SAVE_SKIPPED. If error saving, then IO_ERROR is thrown.
Exceptions
IO_ERRORif there is a problem saving.

Definition at line 264 of file symbol_lib_table.cpp.

References FindRow(), FROM_UTF8(), LIB_TABLE_ROW::GetFullURI(), LIB_PART::GetLibId(), LIB_ID::GetLibItemName(), LIB_TABLE_ROW::GetProperties(), SCH_PLUGIN::LoadSymbol(), SYMBOL_LIB_TABLE_ROW::plugin, SAVE_OK, SAVE_SKIPPED, and SCH_PLUGIN::SaveSymbol().

266 {
267  const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname );
268  wxASSERT( (SCH_PLUGIN*) row->plugin );
269 
270  if( !aOverwrite )
271  {
272  // Try loading the footprint to see if it already exists, caller wants overwrite
273  // protection, which is atypical, not the default.
274 
275  wxString name = FROM_UTF8( aSymbol->GetLibId().GetLibItemName() );
276 
277  std::unique_ptr< LIB_ALIAS > symbol( row->plugin->LoadSymbol( row->GetFullURI( true ),
278  name,
279  row->GetProperties() ) );
280 
281  if( symbol.get() )
282  return SAVE_SKIPPED;
283  }
284 
285  row->plugin->SaveSymbol( row->GetFullURI( true ), aSymbol, row->GetProperties() );
286 
287  return SAVE_OK;
288 }
virtual LIB_ALIAS * LoadSymbol(const wxString &aLibraryPath, const wxString &aAliasName, const PROPERTIES *aProperties=NULL)
Function LoadSymbol.
Definition: sch_plugin.cpp:101
Class SYMBOL_LIB_TABLE_ROW.
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
const SYMBOL_LIB_TABLE_ROW * FindRow(const wxString &aNickName)
Function FindRow.
const PROPERTIES * GetProperties() const
Function GetProperties.
SCH_PLUGIN::SCH_PLUGIN_RELEASER plugin
const LIB_ID & GetLibId() const
const wxString GetFullURI(bool aSubstituted=false) const
Function GetFullURI.
Class SCH_PLUGIN is a base class that SCHEMATIC loading and saving plugins should derive from...
Definition: sch_io_mgr.h:187
const UTF8 & GetLibItemName() const
Function GetLibItemName.
Definition: lib_id.h:129
virtual void SaveSymbol(const wxString &aLibraryPath, const LIB_PART *aSymbol, const PROPERTIES *aProperties=NULL)
Function SaveSymbol.
Definition: sch_plugin.cpp:110

Member Data Documentation

LIB_TABLE* LIB_TABLE::fallBack
protectedinherited
SYMBOL_LIB_TABLE SYMBOL_LIB_TABLE::m_globalLibTable
staticprivate

Definition at line 296 of file symbol_lib_table.h.

Referenced by GetGlobalLibTable().

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 files: