SYMBOL_LIB_TABLE Class Reference

#include <symbol_lib_table.h>

Inheritance diagram for SYMBOL_LIB_TABLE:

Public Types
enum	SAVE_T { SAVE_OK , SAVE_SKIPPED }
	The set of return values from SaveSymbol() below. More...

Public Member Functions
KICAD_T	Type () override
virtual void	Parse (LIB_TABLE_LEXER *aLexer) override
	Parse the #LIB_TABLE_LEXER s-expression library table format into the appropriate LIB_TABLE_ROW objects. More...
virtual void	Format (OUTPUTFORMATTER *aOutput, int aIndentLevel) const override
	Generate the table in s-expression format to aOutput with an indentation level of aIndentLevel. More...
	SYMBOL_LIB_TABLE (SYMBOL_LIB_TABLE *aFallBackTable=nullptr)
	Build a symbol library table by pre-pending this table fragment in front of aFallBackTable. More...
SYMBOL_LIB_TABLE_ROW *	FindRow (const wxString &aNickName, bool aCheckIfEnabled=false)
	Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table fragment. More...
int	GetModifyHash ()
void	EnumerateSymbolLib (const wxString &aNickname, wxArrayString &aAliasNames, bool aPowerSymbolsOnly=false)
	Return a list of symbol alias names contained within the library given by aNickname. More...
void	LoadSymbolLib (std::vector< LIB_SYMBOL * > &aAliasList, const wxString &aNickname, bool aPowerSymbolsOnly=false)
LIB_SYMBOL *	LoadSymbol (const wxString &aNickname, const wxString &aName)
	Load a LIB_SYMBOL having aName from the library given by aNickname. More...
LIB_SYMBOL *	LoadSymbol (const LIB_ID &aLibId)
SAVE_T	SaveSymbol (const wxString &aNickname, const LIB_SYMBOL *aSymbol, bool aOverwrite=true)
	Write aSymbol to an existing library given by aNickname. More...
void	DeleteSymbol (const wxString &aNickname, const wxString &aSymbolName)
	Deletes the aSymbolName from the library given by aNickname. More...
bool	IsSymbolLibWritable (const wxString &aNickname)
	Return true if the library given by aNickname is writable. More...
bool	IsSymbolLibLoaded (const wxString &aNickname)
	Return true if the library given by aNickname was successfully loaded. More...
void	DeleteSymbolLib (const wxString &aNickname)
void	CreateSymbolLib (const wxString &aNickname)
LIB_SYMBOL *	LoadSymbolWithOptionalNickname (const LIB_ID &aId)
	Load a LIB_SYMBOL having aFootprintId with possibly an empty library nickname. More...
void	Clear ()
	Delete all rows. More...
bool	operator== (const LIB_TABLE &r) const
	Compares this table against another. More...
bool	operator!= (const LIB_TABLE &r) const
unsigned	GetCount () const
	Get the number of rows contained in the table. More...
LIB_TABLE_ROW &	At (unsigned aIndex)
	Get the 'n'th LIB_TABLE_ROW object. More...
const LIB_TABLE_ROW &	At (unsigned aIndex) const
	Get the 'n'th LIB_TABLE_ROW object. More...
bool	IsEmpty (bool aIncludeFallback=true)
	Return true if the table is empty. More...
const wxString	GetDescription (const wxString &aNickname)
bool	HasLibrary (const wxString &aNickname, bool aCheckEnabled=false) const
	Test for the existence of aNickname in the library table. More...
bool	HasLibraryWithPath (const wxString &aPath) const
	Test for the existence of aPath in the library table. More...
std::vector< wxString >	GetLogicalLibs ()
	Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE. More...
wxString	GetFullURI (const wxString &aLibNickname, bool aExpandEnvVars=true) const
	Return the full URI of the library mapped to aLibNickname. More...
bool	InsertRow (LIB_TABLE_ROW *aRow, bool doReplace=false)
	Adds aRow if it does not already exist or if doReplace is true. More...
bool	RemoveRow (const LIB_TABLE_ROW *aRow)
	Removes a row from the table. More...
const LIB_TABLE_ROW *	FindRowByURI (const wxString &aURI)
void	Load (const wxString &aFileName)
	Load the library table using the path defined by aFileName aFallBackTable. More...
void	Save (const wxString &aFileName) const
	Write this library table to aFileName in s-expression form. More...

Static Public Member Functions
static bool	LoadGlobalTable (SYMBOL_LIB_TABLE &aTable)
	Load the global symbol library table into aTable. More...
static wxString	GetGlobalTableFileName ()
	Fetch the global symbol library table file name. More...
static const wxString	GlobalPathEnvVariableName ()
	Return the name of the environment variable used to hold the directory of locally installed "KiCad sponsored" system symbol libraries. More...
static SYMBOL_LIB_TABLE &	GetGlobalLibTable ()
static const wxString &	GetSymbolLibTableFileName ()
static PROPERTIES *	ParseOptions (const std::string &aOptionsList)
	Parses aOptionsList and places the result into a PROPERTIES object which is returned. More...
static UTF8	FormatOptions (const PROPERTIES *aProperties)
	Returns a list of options from the aProperties parameter. More...

Static Public Attributes
static const char *	PropPowerSymsOnly = "pwr_sym_only"
static const char *	PropNonPowerSymsOnly = "non_pwr_sym_only"

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

Protected Member Functions
LIB_TABLE_ROW *	findRow (const wxString &aNickname, bool aCheckIfEnabled=false) const
	Return 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_TABLE *	fallBack
std::mutex	m_nickIndexMutex
	Mutex to protect access to the nickIndex variable. More...

Static Private Attributes
static int	m_modifyHash = 1
	helper for GetModifyHash() More...

Friends
class	SYMBOL_LIB_TABLE_GRID
class	PANEL_SYM_LIB_TABLE

Detailed Description

Definition at line 131 of file symbol_lib_table.h.

Member Typedef Documentation

INDEX

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

protectedinherited

this is a non-owning index into the LIB_TABLE_ROWS table

Definition at line 561 of file lib_table_base.h.

INDEX_CITER

typedef INDEX::const_iterator LIB_TABLE::INDEX_CITER

protectedinherited

Definition at line 563 of file lib_table_base.h.

INDEX_ITER

typedef INDEX::iterator LIB_TABLE::INDEX_ITER

protectedinherited

Definition at line 562 of file lib_table_base.h.

INDEX_VALUE

typedef INDEX::value_type LIB_TABLE::INDEX_VALUE

protectedinherited

Definition at line 564 of file lib_table_base.h.

Member Enumeration Documentation

SAVE_T

enum SYMBOL_LIB_TABLE::SAVE_T

The set of return values from SaveSymbol() below.

Enumerator
SAVE_OK
SAVE_SKIPPED

Definition at line 204 of file symbol_lib_table.h.

 {
 SAVE_OK,
 SAVE_SKIPPED,
 };

Constructor & Destructor Documentation

SYMBOL_LIB_TABLE()

SYMBOL_LIB_TABLE::SYMBOL_LIB_TABLE

(

SYMBOL_LIB_TABLE *

aFallBackTable = nullptr

)

Build a symbol library table by pre-pending this table fragment in front of aFallBackTable.

Loading of this table fragment is done by using Parse().

Parameters

aFallBackTable

is 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 102 of file symbol_lib_table.cpp.

 :
 LIB_TABLE( aFallBackTable )
{
 // not copying fall back, simply search aFallBackTable separately
 // if "nickName not found".
}

Member Function Documentation

At() [1/2]

LIB_TABLE_ROW & LIB_TABLE::At ( unsigned  aIndex )

inlineinherited

Get the 'n'th LIB_TABLE_ROW object.

Parameters

aIndex

index of row (must exist: from 0 to GetCount() - 1)

Returns

reference to the row

Definition at line 386 of file lib_table_base.h.

 {
 return rows[aIndex];
 }

References LIB_TABLE::rows.

Referenced by FP_LIB_TABLE::LoadGlobalTable(), LoadGlobalTable(), SYMBOL_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), and PCB::IFACE::SaveFileAs().

At() [2/2]

const LIB_TABLE_ROW & LIB_TABLE::At ( unsigned  aIndex ) const

inlineinherited

Get the 'n'th LIB_TABLE_ROW object.

Parameters

aIndex

index of row (must exist: from 0 to GetCount() - 1)

Returns

reference to the row

Definition at line 394 of file lib_table_base.h.

 {
 return rows[aIndex];
 }

References LIB_TABLE::rows.

Clear()

void LIB_TABLE::Clear ( )

inlineinherited

Delete all rows.

Definition at line 341 of file lib_table_base.h.

 {
 std::lock_guard<std::mutex> lock( m_nickIndexMutex );
 
 rows.clear();
 nickIndex.clear();
 }

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

Referenced by PANEL_SYM_LIB_TABLE::TransferDataFromWindow(), and PANEL_FP_LIB_TABLE::TransferDataFromWindow().

CreateSymbolLib()

void SYMBOL_LIB_TABLE::CreateSymbolLib

(

const wxString &

aNickname

)

Definition at line 479 of file symbol_lib_table.cpp.

{
 const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxCHECK( row && row->plugin, /* void */ );
 row->plugin->CreateSymbolLib( row->GetFullURI( true ), row->GetProperties() );
}

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

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary().

DeleteSymbol()

void SYMBOL_LIB_TABLE::DeleteSymbol	(	const wxString &	aNickname,
		const wxString &	aSymbolName
	)

Deletes the aSymbolName from the library given by aNickname.

Parameters

aNickname	is a locator for the "library", it is a "name" in LIB_TABLE_ROW.
aSymbolName	is the name of a symbol to delete from the specified library.

Exceptions

IO_ERROR

if there is a problem finding the footprint or the library, or deleting it.

Definition at line 448 of file symbol_lib_table.cpp.

{
 const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxCHECK( row && row->plugin, /* void */ );
 return row->plugin->DeleteSymbol( row->GetFullURI( true ), aSymbolName, row->GetProperties() );
}

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

Referenced by SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer().

DeleteSymbolLib()

void SYMBOL_LIB_TABLE::DeleteSymbolLib

(

const wxString &

aNickname

)

Definition at line 471 of file symbol_lib_table.cpp.

{
 const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxCHECK( row && row->plugin, /* void */ );
 row->plugin->DeleteSymbolLib( row->GetFullURI( true ), row->GetProperties() );
}

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

ensureIndex()

void LIB_TABLE::ensureIndex ( )

inlineprotectedinherited

Definition at line 544 of file lib_table_base.h.

 {
 // The dialog lib table editor may not maintain the nickIndex.
 // Lazy indexing may be required. To handle lazy indexing, we must enforce
 // that "nickIndex" is either empty or accurate, but never inaccurate.
 if( !nickIndex.size() )
 reindex();
 }

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

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

EnumerateSymbolLib()

void SYMBOL_LIB_TABLE::EnumerateSymbolLib	(	const wxString &	aNickname,
		wxArrayString &	aAliasNames,
		bool	aPowerSymbolsOnly = false
	)

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

Parameters

aNickname	is a locator for the "library", it is a "name" in LIB_TABLE_ROW.
aAliasNames	is a reference to an array for the alias names.
aPowerSymbolsOnly	is a flag to enumerate only power symbols.

Exceptions

IO_ERROR

if the library cannot be found or loaded.

Definition at line 305 of file symbol_lib_table.cpp.

{
 SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxCHECK( row && row->plugin, /* void */ );
 
 wxString options = row->GetOptions();
 
 if( aPowerSymbolsOnly )
 row->SetOptions( row->GetOptions() + " " + PropPowerSymsOnly );
 
 row->SetLoaded( false );
 row->plugin->EnumerateSymbolLib( aAliasNames, row->GetFullURI( true ), row->GetProperties() );
 row->SetLoaded( true );
 
 if( aPowerSymbolsOnly )
 row->SetOptions( options );
}

References SCH_PLUGIN::EnumerateSymbolLib(), FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetOptions(), LIB_TABLE_ROW::GetProperties(), SYMBOL_LIB_TABLE_ROW::plugin, PropPowerSymsOnly, LIB_TABLE_ROW::SetLoaded(), and LIB_TABLE_ROW::SetOptions().

Referenced by SYMBOL_LIBRARY_MANAGER::getOriginalSymbols().

FindRow()

SYMBOL_LIB_TABLE_ROW * SYMBOL_LIB_TABLE::FindRow	(	const wxString &	aNickName,
		bool	aCheckIfEnabled = false
	)

Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table fragment.

The SCH_PLUGIN is loaded and attached to the "plugin" fieldf the SYMBOL_LIB_TABLE_ROW if not already loaded.

Parameters

aNickName	is the name of the row to find.
aCheckIfEnabled	is a flag to verify if the table entry is enabled or disabled.

Returns

the row found or NULL if aNickName was not found.

Definition at line 325 of file symbol_lib_table.cpp.

{
 SYMBOL_LIB_TABLE_ROW* row =
 dynamic_cast< SYMBOL_LIB_TABLE_ROW* >( findRow( aNickname, aCheckIfEnabled ) );
 
 if( !row )
 return nullptr;
 
 // We've been 'lazy' up until now, but it cannot be deferred any longer,
 // instantiate a PLUGIN of the proper kind if it is not already in this
 // SYMBOL_LIB_TABLE_ROW.
 if( !row->plugin )
 {
 row->setPlugin( SCH_IO_MGR::FindPlugin( row->type ) );
 row->plugin->SetLibTable( this );
 }
 
 return row;
}

References LIB_TABLE::findRow(), SYMBOL_LIB_TABLE_ROW::plugin, SCH_PLUGIN::SetLibTable(), SYMBOL_LIB_TABLE_ROW::setPlugin(), and SYMBOL_LIB_TABLE_ROW::type.

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), CreateSymbolLib(), DeleteSymbol(), DeleteSymbolLib(), EnumerateSymbolLib(), SYMBOL_LIBRARY_MANAGER::GetLibrary(), GetModifyHash(), IsSymbolLibLoaded(), IsSymbolLibWritable(), LoadGlobalTable(), SCH_EDIT_FRAME::LoadSheetFromFile(), LoadSymbol(), LoadSymbolLib(), SCH_BASE_FRAME::PickSymbolFromLibTree(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SaveSymbol(), and ERC_TESTER::TestLibSymbolIssues().

findRow()

LIB_TABLE_ROW * LIB_TABLE::findRow ( const wxString &  aNickname, bool  aCheckIfEnabled = false  ) const

protectedinherited

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

Parameters

aNickname	is the name of the library table entry to find.
aCheckIfEnabled	is a flag to check if the library table entry is enabled.

Returns

a pointer to the LIB_TABLE_ROW found.

Definition at line 196 of file lib_table_base.cpp.

{
 LIB_TABLE_ROW* row = nullptr;
 LIB_TABLE* cur = (LIB_TABLE*) this;
 
 do
 {
 cur->ensureIndex();
 
 for( const std::pair<const wxString, int>& entry : cur->nickIndex )
 {
 if( entry.first == aNickName )
 {
 row = &cur->rows[entry.second];
 
 if( !aCheckIfEnabled || row->GetIsEnabled() )
 return row;
 }
 }
 
 // Repeat, this time looking for names that were "fixed" by legacy versions because
 // the old eeschema file format didn't support spaces in tokens.
 for( const std::pair<const wxString, int>& entry : cur->nickIndex )
 {
 wxString legacyLibName = entry.first;
 legacyLibName.Replace( " ", "_" );
 
 if( legacyLibName == aNickName )
 {
 row = &cur->rows[entry.second];
 
 if( !aCheckIfEnabled || row->GetIsEnabled() )
 return row;
 }
 }
 
 // not found, search fall back table(s), if any
 } while( ( cur = cur->fallBack ) != nullptr );
 
 return nullptr; // not found
}

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

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

FindRowByURI()

const LIB_TABLE_ROW * LIB_TABLE::FindRowByURI ( const wxString &  aURI )

inherited

Returns

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

Definition at line 239 of file lib_table_base.cpp.

{
 LIB_TABLE* cur = this;
 
 do
 {
 cur->ensureIndex();
 
 for( unsigned i = 0; i < cur->rows.size(); i++ )
 {
 wxString tmp = cur->rows[i].GetFullURI( true );
 
 if( tmp.Find( "://" ) != wxNOT_FOUND )
 {
 if( tmp == aURI )
 return &cur->rows[i]; // found as URI
 }
 else
 {
 wxFileName fn = aURI;
 
 // This will also test if the file is a symlink so if we are comparing
 // a symlink to the same real file, the comparison will be true. See
 // wxFileName::SameAs() in the wxWidgets source.
 if( fn == wxFileName( tmp ) )
 return &cur->rows[i]; // found as full path and file name
 }
 }
 
 // not found, search fall back table(s), if any
 } while( ( cur = cur->fallBack ) != nullptr );
 
 return nullptr; // not found
}

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

Referenced by PCB_EDIT_FRAME::ExportFootprintsToLibrary(), SYMBOL_EDIT_FRAME::KiwayMailIn(), and FOOTPRINT_EDIT_FRAME::KiwayMailIn().

Format()

void SYMBOL_LIB_TABLE::Format ( OUTPUTFORMATTER *  aOutput, int  aIndentLevel  ) const

overridevirtual

Generate the table in s-expression format to aOutput with an indentation level of aIndentLevel.

Parameters

aOutput	is the OUTPUTFORMATTER to format the table into.
aIndentLevel	is the indentation level (2 spaces) to indent.

Exceptions

IO_ERROR	if an I/O error occurs during output.
boost::interprocess::lock_except	if separate process attempt to access the table.

Implements LIB_TABLE.

Definition at line 268 of file symbol_lib_table.cpp.

{
 aOutput->Print( aIndentLevel, "(sym_lib_table\n" );
 
 for( LIB_TABLE_ROWS_CITER it = rows.begin(); it != rows.end(); ++it )
 {
 it->Format( aOutput, aIndentLevel+1 );
 }
 
 aOutput->Print( aIndentLevel, ")\n" );
}

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

Referenced by DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), and SCH_EAGLE_PLUGIN::Load().

FormatOptions()

UTF8 LIB_TABLE::FormatOptions ( const PROPERTIES *  aProperties )

staticinherited

Returns a list of options from the aProperties parameter.

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

Parameters

aProperties

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

Definition at line 423 of file lib_table_base.cpp.

{
 UTF8 ret;
 
 if( aProperties )
 {
 for( PROPERTIES::const_iterator it = aProperties->begin(); it != aProperties->end(); ++it )
 {
 const std::string& name = it->first;
 
 const UTF8& value = it->second;
 
 if( ret.size() )
 ret += OPT_SEP;
 
 ret += name;
 
 // the separation between name and value is '='
 if( value.size() )
 {
 ret += '=';
 
 for( std::string::const_iterator si = value.begin(); si != value.end(); ++si )
 {
 // escape any separator in the value.
 if( *si == OPT_SEP )
 ret += '\\';
 
 ret += *si;
 }
 }
 }
 }
 
 return ret;
}

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

Referenced by DIALOG_FP_PLUGIN_OPTIONS::TransferDataFromWindow().

GetCount()

unsigned LIB_TABLE::GetCount ( ) const

inlineinherited

Get the number of rows contained in the table.

Definition at line 376 of file lib_table_base.h.

 {
 return rows.size();
 }

References LIB_TABLE::rows.

Referenced by BOOST_AUTO_TEST_CASE(), FP_TREE_SYNCHRONIZING_ADAPTER::GetLibrariesCount(), FP_LIB_TABLE::LoadGlobalTable(), LoadGlobalTable(), SYMBOL_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), and PCB::IFACE::SaveFileAs().

GetDescription()

const wxString LIB_TABLE::GetDescription ( const wxString &  aNickname )

inherited

Returns

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

Definition at line 148 of file lib_table_base.cpp.

{
 // Use "no exception" form of find row and ignore disabled flag.
 const LIB_TABLE_ROW* row = findRow( aNickname );
 
 if( row )
 return row->GetDescr();
 else
 return wxEmptyString;
}

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), and PCB_BASE_FRAME::SelectLibrary().

GetFullURI()

wxString LIB_TABLE::GetFullURI ( const wxString &  aLibNickname, bool  aExpandEnvVars = true  ) const

inherited

Return the full URI of the library mapped to aLibNickname.

Definition at line 183 of file lib_table_base.cpp.

{
 const LIB_TABLE_ROW* row = findRow( aNickname, true );
 
 wxString retv;
 
 if( row )
 retv = row->GetFullURI( aExpandEnvVars );
 
 return retv;
}

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

Referenced by CVPCB_MAINFRAME::DisplayStatus(), SCH_EDIT_FRAME::LoadSheetFromFile(), NETLIST_EXPORTER_XML::makeLibraries(), and FOOTPRINT_EDITOR_CONTROL::SaveAs().

GetGlobalLibTable()

SYMBOL_LIB_TABLE & SYMBOL_LIB_TABLE::GetGlobalLibTable ( )

static

Definition at line 110 of file symbol_lib_table.cpp.

{
 return g_symbolLibraryTable;
}

References g_symbolLibraryTable.

Referenced by SYMBOL_EDIT_FRAME::AddLibraryFile(), SYMBOL_EDIT_FRAME::addLibTableEntry(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SYMBOL_EDIT_FRAME::DdAddLibrary(), SYMBOL_EDIT_FRAME::ExportSymbol(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), DIALOG_SYMBOL_REMAP::getLibsNotInGlobalSymbolLibTable(), InvokeSchEditSymbolLibTable(), SCH::IFACE::OnKifaceStart(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_BASE_FRAME::saveSymbolLibTables(), SCH_BASE_FRAME::SelectSymLibTable(), SYMBOL_TREE_PANE::SYMBOL_TREE_PANE(), and DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow().

GetGlobalTableFileName()

wxString SYMBOL_LIB_TABLE::GetGlobalTableFileName ( )

static

Fetch the global symbol library table file name.

Returns

the platform specific global symbol library path and file name.

Definition at line 667 of file symbol_lib_table.cpp.

{
 wxFileName fn;
 
 fn.SetPath( SETTINGS_MANAGER::GetUserSettingsPath() );
 fn.SetName( global_tbl_name );
 
 return fn.GetFullPath();
}

References SETTINGS_MANAGER::GetUserSettingsPath(), and global_tbl_name().

Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::GetGlobalTableFileName(), InvokeSchEditSymbolLibTable(), LoadGlobalTable(), SCH::IFACE::OnKifaceStart(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_BASE_FRAME::saveSymbolLibTables(), and DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow().

GetLogicalLibs()

std::vector< wxString > LIB_TABLE::GetLogicalLibs ( )

inherited

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

Definition at line 275 of file lib_table_base.cpp.

{
 // Only return unique logical library names. Use std::set::insert() to quietly reject any
 // duplicates (usually due to encountering a duplicate nickname in a fallback table).
 
 std::set<wxString> unique;
 std::vector<wxString> ret;
 const LIB_TABLE* cur = this;
 
 do
 {
 for( LIB_TABLE_ROWS_CITER it = cur->rows.begin(); it!=cur->rows.end(); ++it )
 {
 if( it->GetIsEnabled() )
 unique.insert( it->GetNickName() );
 }
 
 } while( ( cur = cur->fallBack ) != nullptr );
 
 ret.reserve( unique.size() );
 
 // return a sorted, unique set of nicknames in a std::vector<wxString> to caller
 for( std::set< wxString >::const_iterator it = unique.begin(); it!=unique.end(); ++it )
 ret.push_back( *it );
 
 // We want to allow case-sensitive duplicates but sort by case-insensitive ordering
 std::sort( ret.begin(), ret.end(),
 []( const wxString& lhs, const wxString& rhs )
 {
 return StrNumCmp( lhs, rhs, true /* ignore case */ ) < 0;
 } );
 
 return ret;
}

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

Referenced by FP_TREE_MODEL_ADAPTER::AddLibraries(), CVPCB_MAINFRAME::BuildLibrariesListBox(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), FP_LIB_TABLE::GenerateTimestamp(), GetFootprintLibraries(), SYMBOL_LIBRARY_MANAGER::GetLibraryCount(), GetModifyHash(), guessNickname(), CVPCB_MAINFRAME::LoadFootprintFiles(), LoadSymbolWithOptionalNickname(), FOOTPRINT_VIEWER_FRAME::OnActivate(), SYMBOL_VIEWER_FRAME::OnSelectSymbol(), SCH_BASE_FRAME::PickSymbolFromLibTree(), FOOTPRINT_LIST_IMPL::ReadFootprintFiles(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), PCB_BASE_FRAME::SelectLibrary(), and FP_TREE_SYNCHRONIZING_ADAPTER::Sync().

GetModifyHash()

int SYMBOL_LIB_TABLE::GetModifyHash

(

)

Definition at line 281 of file symbol_lib_table.cpp.

{
 int hash = 0;
 std::vector< wxString > libNames = GetLogicalLibs();
 
 for( const auto& libName : libNames )
 {
 const SYMBOL_LIB_TABLE_ROW* row = FindRow( libName, true );
 
 if( !row || !row->plugin )
 {
 wxFAIL;
 continue;
 }
 
 hash += row->plugin->GetModifyHash();
 }
 
 hash += m_modifyHash;
 
 return hash;
}

References FindRow(), LIB_TABLE::GetLogicalLibs(), SCH_PLUGIN::GetModifyHash(), m_modifyHash, and SYMBOL_LIB_TABLE_ROW::plugin.

Referenced by SYMBOL_LIBRARY_MANAGER::GetHash(), and LIB_SYMBOL_LIBRARY_MANAGER::Sync().

GetSymbolLibTableFileName()

const wxString & SYMBOL_LIB_TABLE::GetSymbolLibTableFileName ( )

static

Definition at line 678 of file symbol_lib_table.cpp.

{
 return global_tbl_name;
}

References global_tbl_name().

Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry(), DIALOG_SYMBOL_REMAP::backupProject(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), InvokeSchEditSymbolLibTable(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_BASE_FRAME::saveSymbolLibTables(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

GlobalPathEnvVariableName()

const wxString SYMBOL_LIB_TABLE::GlobalPathEnvVariableName ( )

static

Return 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 517 of file symbol_lib_table.cpp.

{
 return "KICAD6_SYMBOL_DIR";
}

Referenced by PANEL_SYM_LIB_TABLE::populateEnvironReadOnlyTable().

HasLibrary()

bool LIB_TABLE::HasLibrary ( const wxString &  aNickname, bool  aCheckEnabled = false  ) const

inherited

Test for the existence of aNickname in the library table.

Parameters

aCheckEnabled

if true will only return true for enabled libraries

Returns

true if a library aNickname exists in the table.

Definition at line 160 of file lib_table_base.cpp.

{
 const LIB_TABLE_ROW* row = findRow( aNickname, aCheckEnabled );
 
 if( row == nullptr )
 return false;
 
 return true;
}

References LIB_TABLE::findRow().

Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry(), CVPCB_MAINFRAME::DisplayStatus(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), InvokeSchEditSymbolLibTable(), SYMBOL_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), SYMBOL_LIBRARY_MANAGER::LibraryExists(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_EDIT_FRAME::LoadSheetFromFile(), NETLIST_EXPORTER_XML::makeLibraries(), PCM_FP_LIB_TRAVERSER::OnDir(), PCM_SYM_LIB_TRAVERSER::OnFile(), SCH_BASE_FRAME::PickSymbolFromLibTree(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), FOOTPRINT_VIEWER_FRAME::ShowModal(), SYMBOL_VIEWER_FRAME::ShowModal(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), ERC_TESTER::TestLibSymbolIssues(), and SCH_SCREEN::UpdateSymbolLinks().

HasLibraryWithPath()

bool LIB_TABLE::HasLibraryWithPath ( const wxString &  aPath ) const

inherited

Test for the existence of aPath in the library table.

Parameters

aCheckEnabled

if true will only return true for enabled libraries

Returns

true if a library aNickname exists in the table.

Definition at line 171 of file lib_table_base.cpp.

{
 for( const LIB_TABLE_ROW& row : rows )
 {
 if( row.GetFullURI() == aPath )
 return true;
 }
 
 return false;
}

References LIB_TABLE::rows.

Referenced by PCM_FP_LIB_TRAVERSER::OnDir(), and PCM_SYM_LIB_TRAVERSER::OnFile().

InsertRow()

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

inherited

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

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

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

Parameters

aRow	is the new row to insert, or to forcibly add if doReplace is true.
doReplace	if 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 311 of file lib_table_base.cpp.

{
 ensureIndex();
 
 std::lock_guard<std::mutex> lock( m_nickIndexMutex );
 
 INDEX_CITER it = nickIndex.find( aRow->GetNickName() );
 
 aRow->SetParent( this );
 
 if( it == nickIndex.end() )
 {
 rows.push_back( aRow );
 nickIndex.insert( INDEX_VALUE( aRow->GetNickName(), rows.size() - 1 ) );
 return true;
 }
 
 if( doReplace )
 {
 rows.replace( it->second, aRow );
 return true;
 }
 
 return false;
}

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

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), LIB_TABLE_TEST_FIXTURE::LIB_TABLE_TEST_FIXTURE(), SCH_ALTIUM_PLUGIN::Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), PCM_FP_LIB_TRAVERSER::OnDir(), PCM_SYM_LIB_TRAVERSER::OnFile(), PCB_EDIT_FRAME::OpenProjectFiles(), Parse(), and FP_LIB_TABLE::Parse().

IsEmpty()

bool LIB_TABLE::IsEmpty ( bool  aIncludeFallback = true )

inherited

Return true if the table is empty.

Parameters

aIncludeFallback

is 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 139 of file lib_table_base.cpp.

{
 if( !aIncludeFallback || !fallBack )
 return rows.empty();
 
 return rows.empty() && fallBack->IsEmpty( true );
}

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

Referenced by BOOST_AUTO_TEST_CASE(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), LIB_TABLE::IsEmpty(), and SCH_EDIT_FRAME::LoadSheetFromFile().

IsSymbolLibLoaded()

bool SYMBOL_LIB_TABLE::IsSymbolLibLoaded

(

const wxString &

aNickname

)

Return true if the library given by aNickname was successfully loaded.

Parameters

aNickname

is the library nickname in the symbol library table.

Exceptions

IO_ERROR

if no library at aNickname exists.

Definition at line 463 of file symbol_lib_table.cpp.

{
 const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxCHECK( row, false );
 return row->GetIsLoaded();
}

References FindRow(), and LIB_TABLE_ROW::GetIsLoaded().

Referenced by SYMBOL_LIBRARY_MANAGER::IsLibraryLoaded().

IsSymbolLibWritable()

bool SYMBOL_LIB_TABLE::IsSymbolLibWritable

(

const wxString &

aNickname

)

Return true if the library given by aNickname is writable.

It is possible that some symbols libraries are read only because of where they are installed.

Parameters

aNickname

is the library nickname in the symbol library table.

Exceptions

IO_ERROR

if no library at aNickname exists.

Definition at line 456 of file symbol_lib_table.cpp.

{
 const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxCHECK( row && row->plugin, false );
 return row->plugin->IsSymbolLibWritable( row->GetFullURI( true ) );
}

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

Referenced by SYMBOL_LIBRARY_MANAGER::IsLibraryReadOnly().

Load()

void LIB_TABLE::Load ( const wxString &  aFileName )

inherited

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

Parameters

aFileName

contains the full path to the s-expression file.

Exceptions

IO_ERROR

if an error occurs attempting to load the footprint library table.

Definition at line 338 of file lib_table_base.cpp.

{
 // It's OK if footprint library tables are missing.
 if( wxFileName::IsFileReadable( aFileName ) )
 {
 FILE_LINE_READER reader( aFileName );
 LIB_TABLE_LEXER lexer( &reader );
 
 Parse( &lexer );
 }
}

References LIB_TABLE::Parse().

Referenced by FP_LIB_TABLE::LoadGlobalTable(), LoadGlobalTable(), SCH_EDIT_FRAME::LoadSheetFromFile(), PROJECT::PcbFootprintLibs(), PCB::IFACE::SaveFileAs(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow(), and DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow().

LoadGlobalTable()

bool SYMBOL_LIB_TABLE::LoadGlobalTable ( SYMBOL_LIB_TABLE &  aTable )

static

Load 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

aTable

the SYMBOL_LIB_TABLE object to load.

Returns

true if the global library table exists and is loaded properly.

Exceptions

IO_ERROR

if an error occurs attempting to load the symbol library table.

Definition at line 585 of file symbol_lib_table.cpp.

{
 bool tableExists = true;
 wxFileName fn = GetGlobalTableFileName();
 
 if( !fn.FileExists() )
 {
 tableExists = false;
 
 if( !fn.DirExists() && !fn.Mkdir( 0x777, wxPATH_MKDIR_FULL ) )
 {
 THROW_IO_ERROR( wxString::Format( _( "Cannot create global library table path '%s'." ),
 fn.GetPath() ) );
 }
 
 // Attempt to copy the default global file table from the KiCad
 // template folder to the user's home configuration path.
 SEARCH_STACK ss;
 
 SystemDirsAppend( &ss );
 
 wxString templatePath =
 Pgm().GetLocalEnvVariables().at( wxT( "KICAD6_TEMPLATE_DIR" ) ).GetValue();
 
 if( !templatePath.IsEmpty() )
 ss.AddPaths( templatePath, 0 );
 
 wxString fileName = ss.FindValidPath( global_tbl_name );
 
 // The fallback is to create an empty global symbol table for the user to populate.
 if( fileName.IsEmpty() || !::wxCopyFile( fileName, fn.GetFullPath(), false ) )
 {
 SYMBOL_LIB_TABLE emptyTable;
 
 emptyTable.Save( fn.GetFullPath() );
 }
 }
 
 aTable.Load( fn.GetFullPath() );
 
 SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
 KICAD_SETTINGS* settings = mgr.GetAppSettings<KICAD_SETTINGS>();
 
 wxString packagesPath = Pgm().GetLocalEnvVariables().at( wxT( "KICAD6_3RD_PARTY" ) ).GetValue();
 
 if( settings->m_PcmLibAutoAdd )
 {
 // Scan for libraries in PCM packages directory
 wxFileName d( packagesPath, "" );
 d.AppendDir( "symbols" );
 
 if( d.DirExists() )
 {
 PCM_SYM_LIB_TRAVERSER traverser( packagesPath, aTable, settings->m_PcmLibPrefix );
 wxDir dir( d.GetPath() );
 
 dir.Traverse( traverser );
 }
 }
 
 if( settings->m_PcmLibAutoRemove )
 {
 // Remove PCM libraries that no longer exist
 std::vector<wxString> to_remove;
 
 for( size_t i = 0; i < aTable.GetCount(); i++ )
 {
 LIB_TABLE_ROW& row = aTable.At( i );
 wxString path = row.GetFullURI( true );
 
 if( path.StartsWith( packagesPath ) && !wxFile::Exists( path ) )
 to_remove.push_back( row.GetNickName() );
 }
 
 for( const wxString& nickName : to_remove )
 aTable.RemoveRow( aTable.FindRow( nickName ) );
 }
 
 return tableExists;
}

References _, SEARCH_STACK::AddPaths(), LIB_TABLE::At(), FindRow(), Format(), SETTINGS_MANAGER::GetAppSettings(), LIB_TABLE::GetCount(), LIB_TABLE_ROW::GetFullURI(), GetGlobalTableFileName(), LIB_TABLE_ROW::GetNickName(), global_tbl_name(), LIB_TABLE::Load(), KICAD_SETTINGS::m_PcmLibAutoAdd, KICAD_SETTINGS::m_PcmLibAutoRemove, KICAD_SETTINGS::m_PcmLibPrefix, path, Pgm(), LIB_TABLE::RemoveRow(), LIB_TABLE::Save(), SystemDirsAppend(), and THROW_IO_ERROR.

Referenced by SCH::IFACE::OnKifaceStart(), and DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow().

LoadSymbol() [1/2]

LIB_SYMBOL * SYMBOL_LIB_TABLE::LoadSymbol ( const LIB_ID &  aLibId )

inline

Definition at line 196 of file symbol_lib_table.h.

 {
 return LoadSymbol( aLibId.GetLibNickname(), aLibId.GetLibItemName() );
 }

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), and LoadSymbol().

LoadSymbol() [2/2]

LIB_SYMBOL * SYMBOL_LIB_TABLE::LoadSymbol	(	const wxString &	aNickname,
		const wxString &	aName
	)

Load a LIB_SYMBOL having aName from the library given by aNickname.

Parameters

aNickname	is a locator for the "library", it is a "name" in LIB_TABLE_ROW
aName	is the name of the LIB_SYMBOL to load.
aFlatten	set to true to flatten derived parts.

Returns

the symbol alias if found or NULL if not found.

Exceptions

IO_ERROR

if the library cannot be found or read. No exception is thrown in the case where aNickname cannot be found.

Definition at line 380 of file symbol_lib_table.cpp.

{
 SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 
 if( !row || !row->plugin )
 return nullptr;
 
 // If another thread is loading this library at the moment; continue
 std::unique_lock<std::mutex> lock( row->GetMutex(), std::try_to_lock );
 
 if( !lock.owns_lock() )
 return nullptr;
 
 LIB_SYMBOL* symbol = row->plugin->LoadSymbol( row->GetFullURI( true ), aSymbolName,
 row->GetProperties() );
 
 // The library cannot know its own name, because it might have been renamed or moved.
 // Therefore footprints cannot know their own library nickname when residing in
 // a symbol library.
 // Only at this API layer can we tell the symbol about its actual library nickname.
 if( symbol )
 {
 LIB_ID id = symbol->GetLibId();
 
 id.SetLibNickname( row->GetNickName() );
 symbol->SetLibId( id );
 }
 
 return symbol;
}

References FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_SYMBOL::GetLibId(), LIB_TABLE_ROW::GetMutex(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE_ROW::GetProperties(), SCH_PLUGIN::LoadSymbol(), SYMBOL_LIB_TABLE_ROW::plugin, LIB_SYMBOL::SetLibId(), and LIB_ID::SetLibNickname().

Referenced by FOOTPRINT_INFO_GENERATOR::GenerateHtml(), SYMBOL_LIBRARY_MANAGER::GetAlias(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), SYMBOL_LIBRARY_MANAGER::getOriginalSymbols(), SCH_EAGLE_PLUGIN::loadInstance(), LoadSymbol(), SCH_DATABASE_PLUGIN::loadSymbolFromRow(), LoadSymbolWithOptionalNickname(), SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer(), SchGetLibSymbol(), SYMBOL_LIBRARY_MANAGER::SymbolExists(), and SCH_SCREEN::UpdateSymbolLinks().

LoadSymbolLib()

void SYMBOL_LIB_TABLE::LoadSymbolLib	(	std::vector< LIB_SYMBOL * > &	aAliasList,
		const wxString &	aNickname,
		bool	aPowerSymbolsOnly = false
	)

Definition at line 346 of file symbol_lib_table.cpp.

{
 SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxCHECK( row && row->plugin, /* void */ );
 
 std::lock_guard<std::mutex> lock( row->GetMutex() );
 
 wxString options = row->GetOptions();
 
 if( aPowerSymbolsOnly )
 row->SetOptions( row->GetOptions() + " " + PropPowerSymsOnly );
 
 row->SetLoaded( false );
 row->plugin->EnumerateSymbolLib( aSymbolList, row->GetFullURI( true ), row->GetProperties() );
 row->SetLoaded( true );
 
 if( aPowerSymbolsOnly )
 row->SetOptions( options );
 
 // The library cannot know its own name, because it might have been renamed or moved.
 // Therefore footprints cannot know their own library nickname when residing in
 // a symbol library.
 // Only at this API layer can we tell the symbol about its actual library nickname.
 for( LIB_SYMBOL* symbol : aSymbolList )
 {
 LIB_ID id = symbol->GetLibId();
 
 id.SetLibNickname( row->GetNickName() );
 symbol->SetLibId( id );
 }
}

References SCH_PLUGIN::EnumerateSymbolLib(), FindRow(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetMutex(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE_ROW::GetOptions(), LIB_TABLE_ROW::GetProperties(), SYMBOL_LIB_TABLE_ROW::plugin, PropPowerSymsOnly, LIB_ID::SetLibNickname(), LIB_TABLE_ROW::SetLoaded(), and LIB_TABLE_ROW::SetOptions().

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), SYMBOL_LIBRARY_MANAGER::GetAliases(), and SYMBOL_ASYNC_LOADER::worker().

LoadSymbolWithOptionalNickname()

LIB_SYMBOL * SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname

(

const LIB_ID &

aId

)

Load a LIB_SYMBOL having aFootprintId with possibly an empty library nickname.

Parameters

aId	the library nickname and name of the symbol to load.

Returns

the library symbol if found (the library owns it) or NULL if not found.

Exceptions

IO_ERROR	if the library cannot be found or read. No exception is thrown in the case where aId cannot be found.
PARSE_ERROR	if aId is not parsed OK.

Definition at line 487 of file symbol_lib_table.cpp.

{
 wxString nickname = aLibId.GetLibNickname();
 wxString name = aLibId.GetLibItemName();
 
 if( nickname.size() )
 {
 return LoadSymbol( nickname, name );
 }
 else
 {
 // nickname is empty, sequentially search (alphabetically) all libs/nicks for first match:
 std::vector<wxString> nicks = GetLogicalLibs();
 
 // Search each library going through libraries alphabetically.
 for( unsigned i = 0; i < nicks.size(); ++i )
 {
 // FootprintLoad() returns NULL on not found, does not throw exception
 // unless there's an IO_ERROR.
 LIB_SYMBOL* ret = LoadSymbol( nicks[i], name );
 
 if( ret )
 return ret;
 }
 
 return nullptr;
 }
}

References LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_TABLE::GetLogicalLibs(), LoadSymbol(), and name.

operator!=()

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

inlineinherited

Definition at line 371 of file lib_table_base.h.

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

References r.

operator==()

bool LIB_TABLE::operator== ( const LIB_TABLE &  r ) const

inlineinherited

Compares this table against another.

This compares the row contents against each other. Any fallback tables are not checked.

Definition at line 355 of file lib_table_base.h.

 {
 if( rows.size() == r.rows.size() )
 {
 unsigned i;
 
 for( i = 0; i < rows.size() && rows[i] == r.rows[i]; ++i )
 ;
 
 if( i == rows.size() )
 return true;
 }
 
 return false;
 }

References r, and LIB_TABLE::rows.

Parse()

void SYMBOL_LIB_TABLE::Parse ( LIB_TABLE_LEXER *  aLexer )

overridevirtual

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

Parameters

aLexer

is the lexer to parse.

Exceptions

IO_ERROR	if an I/O error occurs during parsing.
PARSER_ERROR	if the lexer format to parse is invalid.
boost::bad_pointer	if an any attempt to add an invalid pointer to the boost::ptr_vector.
boost::bad_index	if an index outside the row table bounds is accessed.

Implements LIB_TABLE.

Definition at line 116 of file symbol_lib_table.cpp.

{
 T tok;
 wxString errMsg; // to collect error messages
 
 // This table may be nested within a larger s-expression, or not.
 // Allow for parser of that optional containing s-epression to have looked ahead.
 if( in->CurTok() != T_sym_lib_table )
 {
 in->NeedLEFT();
 
 if( ( tok = in->NextTok() ) != T_sym_lib_table )
 in->Expecting( T_sym_lib_table );
 }
 
 while( ( tok = in->NextTok() ) != T_RIGHT )
 {
 std::unique_ptr< SYMBOL_LIB_TABLE_ROW > row = std::make_unique<SYMBOL_LIB_TABLE_ROW>();
 
 if( tok == T_EOF )
 in->Expecting( T_RIGHT );
 
 if( tok != T_LEFT )
 in->Expecting( T_LEFT );
 
 // in case there is a "row integrity" error, tell where later.
 int lineNum = in->CurLineNumber();
 
 if( ( tok = in->NextTok() ) != T_lib )
 in->Expecting( T_lib );
 
 // (name NICKNAME)
 in->NeedLEFT();
 
 if( ( tok = in->NextTok() ) != T_name )
 in->Expecting( T_name );
 
 in->NeedSYMBOLorNUMBER();
 
 row->SetNickName( in->FromUTF8() );
 
 in->NeedRIGHT();
 
 // After (name), remaining (lib) elements are order independent, and in
 // some cases optional.
 bool sawType = false;
 bool sawOpts = false;
 bool sawDesc = false;
 bool sawUri = false;
 bool sawDisabled = false;
 bool sawHidden = false;
 
 while( ( tok = in->NextTok() ) != T_RIGHT )
 {
 if( tok == T_EOF )
 in->Unexpected( T_EOF );
 
 if( tok != T_LEFT )
 in->Expecting( T_LEFT );
 
 tok = in->NeedSYMBOLorNUMBER();
 
 switch( tok )
 {
 case T_uri:
 if( sawUri )
 in->Duplicate( tok );
 sawUri = true;
 in->NeedSYMBOLorNUMBER();
 row->SetFullURI( in->FromUTF8() );
 break;
 
 case T_type:
 if( sawType )
 in->Duplicate( tok );
 sawType = true;
 in->NeedSYMBOLorNUMBER();
 row->SetType( in->FromUTF8() );
 break;
 
 case T_options:
 if( sawOpts )
 in->Duplicate( tok );
 sawOpts = true;
 in->NeedSYMBOLorNUMBER();
 row->SetOptions( in->FromUTF8() );
 break;
 
 case T_descr:
 if( sawDesc )
 in->Duplicate( tok );
 sawDesc = true;
 in->NeedSYMBOLorNUMBER();
 row->SetDescr( in->FromUTF8() );
 break;
 
 case T_disabled:
 if( sawDisabled )
 in->Duplicate( tok );
 sawDisabled = true;
 row->SetEnabled( false );
 break;
 
 case T_hidden:
 if( sawHidden )
 in->Duplicate( tok );
 sawHidden = true;
 row->SetVisible( false );
 break;
 
 default:
 in->Unexpected( tok );
 }
 
 in->NeedRIGHT();
 }
 
 if( !sawType )
 in->Expecting( T_type );
 
 if( !sawUri )
 in->Expecting( T_uri );
 
 // all nickNames within this table fragment must be unique, so we do not
 // use doReplace in InsertRow(). (However a fallBack table can have a
 // conflicting nickName and ours will supercede that one since in
 // FindLib() we search this table before any fall back.)
  wxString nickname = row->GetNickName(); // store it to be able to used it
 // after row deletion if an error occurs
 LIB_TABLE_ROW* tmp = row.release();
 
 if( !InsertRow( tmp ) )
 {
 delete tmp; // The table did not take ownership of the row.
 
 wxString msg = wxString::Format( _( "Duplicate library nickname '%s' found in symbol "
 "library table file line %d" ),
 nickname,
 lineNum );
 
 if( !errMsg.IsEmpty() )
 errMsg << '\n';
 
 errMsg << msg;
 }
 }
 
 if( !errMsg.IsEmpty() )
 THROW_IO_ERROR( errMsg );
}

References _, Format(), LIB_TABLE::InsertRow(), and THROW_IO_ERROR.

Referenced by SYMBOL_GRID_TRICKS::paste_text().

ParseOptions()

PROPERTIES * LIB_TABLE::ParseOptions ( const std::string &  aOptionsList )

staticinherited

Parses aOptionsList and places the result into a PROPERTIES object which is returned.

If the options field is empty, then the returned PROPERTIES will be a NULL pointer.

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

Definition at line 358 of file lib_table_base.cpp.

{
 if( aOptionsList.size() )
 {
 const char* cp = &aOptionsList[0];
 const char* end = cp + aOptionsList.size();
 
 PROPERTIES props;
 std::string pair;
 
 // Parse all name=value pairs
 while( cp < end )
 {
 pair.clear();
 
 // Skip leading white space.
 while( cp < end && isspace( *cp ) )
 ++cp;
 
 // Find the end of pair/field
 while( cp < end )
 {
 if( *cp == '\\' && cp + 1 < end && cp[1] == OPT_SEP )
 {
 ++cp; // skip the escape
 pair += *cp++; // add the separator
 }
 else if( *cp == OPT_SEP )
 {
 ++cp; // skip the separator
 break; // process the pair
 }
 else
 {
 pair += *cp++;
 }
 }
 
 // stash the pair
 if( pair.size() )
 {
 // first equals sign separates 'name' and 'value'.
 size_t eqNdx = pair.find( '=' );
 
 if( eqNdx != pair.npos )
 {
 std::string name = pair.substr( 0, eqNdx );
 std::string value = pair.substr( eqNdx + 1 );
 props[name] = value;
 }
 else
 {
 props[pair] = ""; // property is present, but with no value.
 }
 }
 }
 
 if( props.size() )
 return new PROPERTIES( props );
 }
 
 return nullptr;
}

References name, and OPT_SEP.

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

reindex()

void LIB_TABLE::reindex ( )

inlineprotectedinherited

Definition at line 534 of file lib_table_base.h.

 {
 std::lock_guard<std::mutex> lock( m_nickIndexMutex );
 
 nickIndex.clear();
 
 for( LIB_TABLE_ROWS_ITER it = rows.begin(); it != rows.end(); ++it )
 nickIndex.insert( INDEX_VALUE( it->GetNickName(), it - rows.begin() ) );
 }

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

Referenced by LIB_TABLE::ensureIndex(), PANEL_SYM_LIB_TABLE::TransferDataFromWindow(), and PANEL_FP_LIB_TABLE::TransferDataFromWindow().

RemoveRow()

bool LIB_TABLE::RemoveRow ( const LIB_TABLE_ROW *  aRow )

inlineinherited

Removes a row from the table.

Parameters

aRow	is the row to remove

Returns

true if the row was found (and removed)

Definition at line 461 of file lib_table_base.h.

 {
 for( auto iter = rows.begin(); iter != rows.end(); ++iter )
 {
 if( *iter == *aRow )
 {
 rows.erase( iter, iter + 1 );
 return true;
 }
 }
 return false;
 }

References LIB_TABLE::rows.

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary(), FP_LIB_TABLE::LoadGlobalTable(), and LoadGlobalTable().

Save()

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

inherited

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

Parameters

aFileName

is the name of the file to write to.

Definition at line 351 of file lib_table_base.cpp.

{
 FILE_OUTPUTFORMATTER sf( aFileName );
 Format( &sf, 0 );
}

References LIB_TABLE::Format().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), FP_LIB_TABLE::LoadGlobalTable(), LoadGlobalTable(), PCB_EDIT_FRAME::OpenProjectFiles(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), PCB::IFACE::SaveFileAs(), SCH_BASE_FRAME::saveSymbolLibTables(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow(), and DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow().

SaveSymbol()

SYMBOL_LIB_TABLE::SAVE_T SYMBOL_LIB_TABLE::SaveSymbol	(	const wxString &	aNickname,
		const LIB_SYMBOL *	aSymbol,
		bool	aOverwrite = true
	)

Write aSymbol to an existing library given by aNickname.

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

Parameters

aNickname	is a locator for the "library", it is a "name" in LIB_TABLE_ROW
aSymbol	is what to store in the library. The library owns the symbol after this call.
aOverwrite	when 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_ERROR

if there is a problem saving the symbol.

Definition at line 412 of file symbol_lib_table.cpp.

{
 const SYMBOL_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxCHECK( row && row->plugin, SAVE_SKIPPED );
 
 if( !row->plugin->IsSymbolLibWritable( row->GetFullURI( true ) ) )
 return SAVE_SKIPPED;
 
 if( !aOverwrite )
 {
 // Try loading the footprint to see if it already exists, caller wants overwrite
 // protection, which is atypical, not the default.
 
 wxString name = aSymbol->GetLibId().GetLibItemName();
 
 std::unique_ptr<LIB_SYMBOL> symbol( row->plugin->LoadSymbol( row->GetFullURI( true ),
 name, row->GetProperties() ) );
 
 if( symbol.get() )
 return SAVE_SKIPPED;
 }
 
 try
 {
 row->plugin->SaveSymbol( row->GetFullURI( true ), aSymbol, row->GetProperties() );
 }
 catch( const IO_ERROR& )
 {
 return SAVE_SKIPPED;
 }
 
 return SAVE_OK;
}

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

Referenced by SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer().

Type()

KICAD_T SYMBOL_LIB_TABLE::Type ( )

inlineoverridevirtual

Implements PROJECT::_ELEM.

Definition at line 134 of file symbol_lib_table.h.

{ return SYMBOL_LIB_TABLE_T; }

References SYMBOL_LIB_TABLE_T.

Friends And Related Function Documentation

PANEL_SYM_LIB_TABLE

friend class PANEL_SYM_LIB_TABLE

friend

Definition at line 311 of file symbol_lib_table.h.

SYMBOL_LIB_TABLE_GRID

friend class SYMBOL_LIB_TABLE_GRID

friend

Definition at line 310 of file symbol_lib_table.h.

Member Data Documentation

fallBack

LIB_TABLE* LIB_TABLE::fallBack

protectedinherited

Definition at line 569 of file lib_table_base.h.

Referenced by LIB_TABLE::findRow(), LIB_TABLE::FindRowByURI(), LIB_TABLE::GetLogicalLibs(), and LIB_TABLE::IsEmpty().

m_modifyHash

int SYMBOL_LIB_TABLE::m_modifyHash = 1

staticprivate

helper for GetModifyHash()

Definition at line 313 of file symbol_lib_table.h.

Referenced by GetModifyHash().

m_nickIndexMutex

std::mutex LIB_TABLE::m_nickIndexMutex

mutableprotectedinherited

Mutex to protect access to the nickIndex variable.

Definition at line 572 of file lib_table_base.h.

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

nickIndex

INDEX LIB_TABLE::nickIndex

protectedinherited

this particular key is the nickName within each row.

Definition at line 567 of file lib_table_base.h.

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

PropNonPowerSymsOnly

const char * SYMBOL_LIB_TABLE::PropNonPowerSymsOnly = "non_pwr_sym_only"

static

Definition at line 137 of file symbol_lib_table.h.

PropPowerSymsOnly

const char * SYMBOL_LIB_TABLE::PropPowerSymsOnly = "pwr_sym_only"

static

Definition at line 136 of file symbol_lib_table.h.

Referenced by EnumerateSymbolLib(), SCH_DATABASE_PLUGIN::EnumerateSymbolLib(), SCH_SEXPR_PLUGIN::EnumerateSymbolLib(), SCH_LEGACY_PLUGIN::EnumerateSymbolLib(), and LoadSymbolLib().

rows

LIB_TABLE_ROWS LIB_TABLE::rows

protectedinherited

Definition at line 558 of file lib_table_base.h.

Referenced by SYMBOL_LIB_TABLE_GRID::at(), FP_LIB_TABLE_GRID::at(), LIB_TABLE::At(), SYMBOL_LIB_TABLE_GRID::begin(), FP_LIB_TABLE_GRID::begin(), LIB_TABLE::Clear(), SYMBOL_LIB_TABLE_GRID::erase(), FP_LIB_TABLE_GRID::erase(), LIB_TABLE::findRow(), LIB_TABLE::FindRowByURI(), Format(), FP_LIB_TABLE::Format(), FP_LIB_TABLE_GRID::FP_LIB_TABLE_GRID(), LIB_TABLE::GetCount(), LIB_TABLE::GetLogicalLibs(), LIB_TABLE::HasLibraryWithPath(), SYMBOL_LIB_TABLE_GRID::insert(), FP_LIB_TABLE_GRID::insert(), LIB_TABLE::InsertRow(), LIB_TABLE::IsEmpty(), PANEL_SYM_LIB_TABLE::moveDownHandler(), PANEL_FP_LIB_TABLE::moveDownHandler(), PANEL_SYM_LIB_TABLE::moveUpHandler(), PANEL_FP_LIB_TABLE::moveUpHandler(), FP_LIB_TABLE::operator==(), LIB_TABLE::operator==(), SYMBOL_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), SYMBOL_LIB_TABLE_GRID::push_back(), FP_LIB_TABLE_GRID::push_back(), LIB_TABLE::reindex(), LIB_TABLE::RemoveRow(), SYMBOL_LIB_TABLE_GRID::size(), FP_LIB_TABLE_GRID::size(), SYMBOL_LIB_TABLE_GRID::SYMBOL_LIB_TABLE_GRID(), PANEL_SYM_LIB_TABLE::TransferDataFromWindow(), and PANEL_FP_LIB_TABLE::TransferDataFromWindow().

---

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

• symbol_lib_table.h
• symbol_lib_table.cpp