FP_LIB_TABLE Class Reference

#include <fp_lib_table.h>

Inheritance diagram for FP_LIB_TABLE:

Public Types
enum	SAVE_T { SAVE_OK , SAVE_SKIPPED }
	The set of return values from FootprintSave() 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...
	FP_LIB_TABLE (FP_LIB_TABLE *aFallBackTable=nullptr)
	Build a footprint library table by pre-pending this table fragment in front of aFallBackTable. More...
bool	operator== (const FP_LIB_TABLE &aFpTable) const
bool	operator!= (const FP_LIB_TABLE &r) const
const FP_LIB_TABLE_ROW *	FindRow (const wxString &aNickName, bool aCheckIfEnabled=false)
	Return an FP_LIB_TABLE_ROW if aNickName is found in this table or in any chained fall back table fragment. More...
void	FootprintEnumerate (wxArrayString &aFootprintNames, const wxString &aNickname, bool aBestEfforts)
	Return a list of footprint names contained within the library given by aNickname. More...
long long	GenerateTimestamp (const wxString *aNickname)
	Generate a hashed timestamp representing the last-mod-times of the library indicated by aNickname, or all libraries if aNickname is NULL. More...
void	PrefetchLib (const wxString &aNickname)
	If possible, prefetches the specified library (e.g. More...
FOOTPRINT *	FootprintLoad (const wxString &aNickname, const wxString &aFootprintName, bool aKeepUUID=false)
	Load a footprint having aFootprintName from the library given by aNickname. More...
bool	FootprintExists (const wxString &aNickname, const wxString &aFootprintName)
	Indicates whether or not the given footprint already exists in the given library. More...
const FOOTPRINT *	GetEnumeratedFootprint (const wxString &aNickname, const wxString &aFootprintName)
	A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management. More...
SAVE_T	FootprintSave (const wxString &aNickname, const FOOTPRINT *aFootprint, bool aOverwrite=true)
	Write aFootprint to an existing library given by aNickname. More...
void	FootprintDelete (const wxString &aNickname, const wxString &aFootprintName)
	Delete the aFootprintName from the library given by aNickname. More...
bool	IsFootprintLibWritable (const wxString &aNickname)
	Return true if the library given by aNickname is writable. More...
void	FootprintLibDelete (const wxString &aNickname)
void	FootprintLibCreate (const wxString &aNickname)
FOOTPRINT *	FootprintLoadWithOptionalNickname (const LIB_ID &aFootprintId, bool aKeepUUID=false)
	Load a footprint having aFootprintId with possibly an empty 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...
int	GetVersion () const
	Returns the version number (0 if unset) More...

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

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

Protected Member Functions
LIB_TABLE_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...
bool	migrate ()
	Updates the env vars from older version of KiCad, provided they do not currently resolve to anything. More...
void	reindex (bool aForce)
	Rebuilds the m_nickIndex. More...
void	ensureIndex ()

Protected Attributes
LIB_TABLE_ROWS	m_rows
INDEX	m_nickIndex
	this particular key is the nickName within each row. More...
LIB_TABLE *	m_fallBack
int	m_version
	Versioning to handle importing old tables. More...
std::shared_mutex	m_nickIndexMutex
	Mutex to protect access to the nickIndex variable. More...

Friends
class	FP_LIB_TABLE_GRID

Detailed Description

Definition at line 96 of file fp_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 582 of file lib_table_base.h.

INDEX_CITER

typedef INDEX::const_iterator LIB_TABLE::INDEX_CITER

protectedinherited

Definition at line 584 of file lib_table_base.h.

INDEX_ITER

typedef INDEX::iterator LIB_TABLE::INDEX_ITER

protectedinherited

Definition at line 583 of file lib_table_base.h.

INDEX_VALUE

typedef INDEX::value_type LIB_TABLE::INDEX_VALUE

protectedinherited

Definition at line 585 of file lib_table_base.h.

Member Enumeration Documentation

SAVE_T

enum FP_LIB_TABLE::SAVE_T

The set of return values from FootprintSave() below.

Enumerator
SAVE_OK
SAVE_SKIPPED

Definition at line 198 of file fp_lib_table.h.

 {
 SAVE_OK,
 SAVE_SKIPPED,
 };

Constructor & Destructor Documentation

FP_LIB_TABLE()

FP_LIB_TABLE::FP_LIB_TABLE

(

FP_LIB_TABLE *

aFallBackTable = nullptr

)

Build 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

aFallBackTable

is another FP_LIB_TABLE which is searched only when a row is not found in this table. No ownership is taken of aFallBackTable.

Definition at line 67 of file fp_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 376 of file lib_table_base.h.

 {
 return m_rows[aIndex];
 }

References LIB_TABLE::m_rows.

Referenced by LoadGlobalTable(), SYMBOL_LIB_TABLE::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 384 of file lib_table_base.h.

 {
 return m_rows[aIndex];
 }

References LIB_TABLE::m_rows.

Clear()

void LIB_TABLE::Clear ( )

inlineinherited

Delete all rows.

Definition at line 331 of file lib_table_base.h.

 {
 std::lock_guard<std::shared_mutex> lock( m_nickIndexMutex );
 
 m_rows.clear();
 m_nickIndex.clear();
 }

References LIB_TABLE::m_nickIndex, LIB_TABLE::m_nickIndexMutex, and LIB_TABLE::m_rows.

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

ensureIndex()

void LIB_TABLE::ensureIndex ( )

inlineprotectedinherited

Definition at line 565 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( !m_nickIndex.size() )
 reindex( false );
 }

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

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

FindRow()

const FP_LIB_TABLE_ROW * FP_LIB_TABLE::FindRow	(	const wxString &	aNickName,
		bool	aCheckIfEnabled = false
	)

Return an FP_LIB_TABLE_ROW if aNickName is found in this table or in any chained fall back table fragment.

If aCheckIfEnabled is true, the library will be ignored even if it is disabled. Otherwise, the row found will be returned even if entry is disabled.

The PLUGIN is loaded and attached to the "plugin" field of the FP_LIB_TABLE_ROW if not already loaded.

Parameters

aNickName	is the name of library nickname to find.
aCheckIfEnabled	is the flag to check if the library found is enabled.

Returns

the library NickName if found.

Exceptions

IO_ERROR

if aNickName cannot be found.

Definition at line 310 of file fp_lib_table.cpp.

{
 // Do not optimize this code. Is done this way specifically to fix a runtime
 // error with clang 4.0.1.
 LIB_TABLE_ROW* ltrow = findRow( aNickname, aCheckIfEnabled );
 FP_LIB_TABLE_ROW* row = dynamic_cast< FP_LIB_TABLE_ROW* >( ltrow );
 
 if( !row )
 {
 wxString msg = wxString::Format( _( "fp-lib-table files contain no library named '%s'." ),
 aNickname );
 
 THROW_IO_ERROR( msg );
 }
 
 // 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
 // FP_LIB_TABLE_ROW.
 if( !row->plugin )
 row->setPlugin( IO_MGR::PluginFind( row->type ) );
 
 return row;
}

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

Referenced by FP_TREE_MODEL_ADAPTER::AddLibraries(), EXPORTER_STEP::composePCB(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), FootprintDelete(), FootprintEnumerate(), FootprintExists(), FootprintLibCreate(), FootprintLibDelete(), FootprintLoad(), FootprintSave(), GenerateTimestamp(), GetEnumeratedFootprint(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), idf_export_footprint(), IsFootprintLibWritable(), RENDER_3D_RAYTRACE::load3DModels(), RENDER_3D_OPENGL::load3dModels(), LoadGlobalTable(), PrefetchLib(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), FOOTPRINT_VIEWER_FRAME::UpdateTitle(), and PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists().

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

{
 LIB_TABLE_ROW* row = nullptr;
 LIB_TABLE* cur = (LIB_TABLE*) this;
 
 do
 {
 cur->ensureIndex();
 
 std::shared_lock<std::shared_mutex> lock( cur->m_nickIndexMutex );
 
 for( const std::pair<const wxString, int>& entry : cur->m_nickIndex )
 {
 if( entry.first == aNickName )
 {
 row = &cur->m_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->m_nickIndex )
 {
 wxString legacyLibName = entry.first;
 legacyLibName.Replace( " ", "_" );
 
 if( legacyLibName == aNickName )
 {
 row = &cur->m_rows[entry.second];
 
 if( !aCheckIfEnabled || row->GetIsEnabled() )
 return row;
 }
 }
 
 // not found, search fall back table(s), if any
 } while( ( cur = cur->m_fallBack ) != nullptr );
 
 return nullptr; // not found
}

References LIB_TABLE::ensureIndex(), LIB_TABLE_ROW::GetIsEnabled(), LIB_TABLE::m_fallBack, LIB_TABLE::m_nickIndex, LIB_TABLE::m_nickIndexMutex, and LIB_TABLE::m_rows.

Referenced by SYMBOL_LIB_TABLE::FindRow(), 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 232 of file lib_table_base.cpp.

{
 LIB_TABLE* cur = this;
 
 do
 {
 cur->ensureIndex();
 
 for( unsigned i = 0; i < cur->m_rows.size(); i++ )
 {
 wxString tmp = cur->m_rows[i].GetFullURI( true );
 
 if( tmp.Find( "://" ) != wxNOT_FOUND )
 {
 if( tmp == aURI )
 return &cur->m_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->m_rows[i]; // found as full path and file name
 }
 }
 
 // not found, search fall back table(s), if any
 } while( ( cur = cur->m_fallBack ) != nullptr );
 
 return nullptr; // not found
}

References LIB_TABLE::ensureIndex(), LIB_TABLE::m_fallBack, and LIB_TABLE::m_rows.

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

FootprintDelete()

void FP_LIB_TABLE::FootprintDelete	(	const wxString &	aNickname,
		const wxString &	aFootprintName
	)

Delete the aFootprintName from the library given by aNickname.

Parameters

aNickname	is a locator for the "library", it is a "name" in LIB_TABLE_ROW.
aFootprintName	is the name of a footprint 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 429 of file fp_lib_table.cpp.

{
 const FP_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxASSERT( (PLUGIN*) row->plugin );
 return row->plugin->FootprintDelete( row->GetFullURI( true ), aFootprintName,
 row->GetProperties() );
}

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

Referenced by FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), and FOOTPRINT_EDITOR_CONTROL::RenameFootprint().

FootprintEnumerate()

void FP_LIB_TABLE::FootprintEnumerate	(	wxArrayString &	aFootprintNames,
		const wxString &	aNickname,
		bool	aBestEfforts
	)

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

Parameters

aFootprintNames	is the list to fill with the footprint names found in aNickname
aNickname	is a locator for the "library", it is a "name" in LIB_TABLE_ROW.
aBestEfforts	if true, don't throw on errors.

Exceptions

IO_ERROR

if the library cannot be found, or footprint cannot be loaded.

Definition at line 292 of file fp_lib_table.cpp.

{
 const FP_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxASSERT( (PLUGIN*) row->plugin );
 row->plugin->FootprintEnumerate( aFootprintNames, row->GetFullURI( true ), aBestEfforts,
 row->GetProperties() );
}

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

Referenced by GetFootprints(), guessNickname(), and FOOTPRINT_LIST_IMPL::loadFootprints().

FootprintExists()

bool FP_LIB_TABLE::FootprintExists	(	const wxString &	aNickname,
		const wxString &	aFootprintName
	)

Indicates whether or not the given footprint already exists in the given library.

Definition at line 370 of file fp_lib_table.cpp.

{
 try
 {
 const FP_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxASSERT( (PLUGIN*) row->plugin );
 
 return row->plugin->FootprintExists( row->GetFullURI( true ), aFootprintName,
 row->GetProperties() );
 }
 catch( ... )
 {
 return false;
 }
}

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

Referenced by FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), FOOTPRINT_EDITOR_CONTROL::PasteFootprint(), FOOTPRINT_EDITOR_CONTROL::RenameFootprint(), and FOOTPRINT_EDIT_FRAME::SaveFootprintAs().

FootprintLibCreate()

void FP_LIB_TABLE::FootprintLibCreate

(

const wxString &

aNickname

)

Definition at line 454 of file fp_lib_table.cpp.

{
 const FP_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxASSERT( (PLUGIN*) row->plugin );
 row->plugin->FootprintLibCreate( row->GetFullURI( true ), row->GetProperties() );
}

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

FootprintLibDelete()

void FP_LIB_TABLE::FootprintLibDelete

(

const wxString &

aNickname

)

Definition at line 446 of file fp_lib_table.cpp.

{
 const FP_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxASSERT( (PLUGIN*) row->plugin );
 row->plugin->FootprintLibDelete( row->GetFullURI( true ), row->GetProperties() );
}

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

FootprintLoad()

FOOTPRINT * FP_LIB_TABLE::FootprintLoad	(	const wxString &	aNickname,
		const wxString &	aFootprintName,
		bool	aKeepUUID = false
	)

Load a footprint having aFootprintName from the library given by aNickname.

Parameters

aNickname	is a locator for the "library", it is a "name" in LIB_TABLE_ROW.
aFootprintName	is the name of the footprint to load.
aKeepUUID	= true to keep initial items UUID, false to set new UUID normally true if loaded in the footprint editor, false if loaded in the board editor. Used only in kicad_plugin

Returns

the footprint if found caller owns it, else NULL if not found.

Exceptions

IO_ERROR

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

Definition at line 387 of file fp_lib_table.cpp.

{
 const FP_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxASSERT( (PLUGIN*) row->plugin );
 
 FOOTPRINT* ret = row->plugin->FootprintLoad( row->GetFullURI( true ), aFootprintName,
 aKeepUUID, row->GetProperties() );
 
 setLibNickname( ret, row->GetNickName(), aFootprintName );
 
 return ret;
}

References FindRow(), PLUGIN::FootprintLoad(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE_ROW::GetProperties(), FP_LIB_TABLE_ROW::plugin, and setLibNickname().

Referenced by FootprintLoadWithOptionalNickname(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), and FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint().

FootprintLoadWithOptionalNickname()

FOOTPRINT * FP_LIB_TABLE::FootprintLoadWithOptionalNickname	(	const LIB_ID &	aFootprintId,
		bool	aKeepUUID = false
	)

Load a footprint having aFootprintId with possibly an empty nickname.

Parameters

aFootprintId	the [nickname] and footprint name of the footprint to load.
aKeepUUID	= true to keep initial items UUID, false to set new UUID normally true if loaded in the footprint editor, false if loaded in the board editor used only in kicad_plugin

Returns

the FOOTPRINT if found caller owns it, else NULL if not found.

Exceptions

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

Definition at line 462 of file fp_lib_table.cpp.

{
 wxString nickname = aFootprintId.GetLibNickname();
 wxString fpname = aFootprintId.GetLibItemName();
 
 if( nickname.size() )
 {
 return FootprintLoad( nickname, fpname, aKeepUUID );
 }
 
 // nickname is empty, sequentially search (alphabetically) all libs/nicks for first match:
 else
 {
 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.
 FOOTPRINT* ret = FootprintLoad( nicks[i], fpname, aKeepUUID );
 
 if( ret )
 return ret;
 }
 
 return nullptr;
 }
}

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

Referenced by PCB_BASE_FRAME::loadFootprint().

FootprintSave()

FP_LIB_TABLE::SAVE_T FP_LIB_TABLE::FootprintSave	(	const wxString &	aNickname,
		const FOOTPRINT *	aFootprint,
		bool	aOverwrite = true
	)

Write aFootprint to an existing library given by aNickname.

If a footprint by the same name already exists, it is replaced.

Parameters

aNickname	is a locator for the "library", it is a "name" in LIB_TABLE_ROW.
aFootprint	is what to store in the library. The caller continues to own the footprint after this call.
aOverwrite	when true means overwrite any existing footprint by the same name, else if false means skip the write and return SAVE_SKIPPED.

Returns

SAVE_OK or SAVE_SKIPPED. If error saving, then IO_ERROR is thrown.

Exceptions

IO_ERROR

if there is a problem saving.

Definition at line 402 of file fp_lib_table.cpp.

{
 const FP_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxASSERT( (PLUGIN*) row->plugin );
 
 if( !aOverwrite )
 {
 // Try loading the footprint to see if it already exists, caller wants overwrite
 // protection, which is atypical, not the default.
 
 wxString fpname = aFootprint->GetFPID().GetLibItemName();
 
 std::unique_ptr<FOOTPRINT> footprint( row->plugin->FootprintLoad( row->GetFullURI( true ),
 fpname,
 row->GetProperties() ) );
 
 if( footprint.get() )
 return SAVE_SKIPPED;
 }
 
 row->plugin->FootprintSave( row->GetFullURI( true ), aFootprint, row->GetProperties() );
 
 return SAVE_OK;
}

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

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

Format()

void FP_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 252 of file fp_lib_table.cpp.

{
 aOutput->Print( aIndentLevel, "(fp_lib_table\n" );
 aOutput->Print( aIndentLevel + 1, "(version %d)\n", m_version );
 
 for( LIB_TABLE_ROWS_CITER it = m_rows.begin(); it != m_rows.end(); ++it )
 it->Format( aOutput, aIndentLevel+1 );
 
 aOutput->Print( aIndentLevel, ")\n" );
}

References LIB_TABLE::m_rows, LIB_TABLE::m_version, and OUTPUTFORMATTER::Print().

FormatOptions()

UTF8 LIB_TABLE::FormatOptions ( const STRING_UTF8_MAP *  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 447 of file lib_table_base.cpp.

{
 UTF8 ret;
 
 if( aProperties )
 {
 for( STRING_UTF8_MAP::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().

GenerateTimestamp()

long long FP_LIB_TABLE::GenerateTimestamp

(

const wxString *

aNickname

)

Generate a hashed timestamp representing the last-mod-times of the library indicated by aNickname, or all libraries if aNickname is NULL.

Definition at line 264 of file fp_lib_table.cpp.

{
 long long hash = 0;
 
 if( aNickname )
 {
 const FP_LIB_TABLE_ROW* row = FindRow( *aNickname, true );
 
 wxCHECK( row && row->plugin, hash );
 
 return row->plugin->GetLibraryTimestamp( row->GetFullURI( true ) ) +
 wxHashTable::MakeKey( *aNickname );
 }
 
 for( const wxString& nickname : GetLogicalLibs() )
 {
 const FP_LIB_TABLE_ROW* row = FindRow( nickname, true );
 
 wxCHECK2( row && row->plugin, continue );
 
 hash += row->plugin->GetLibraryTimestamp( row->GetFullURI( true ) ) +
 wxHashTable::MakeKey( nickname );
 }
 
 return hash;
}

References FindRow(), LIB_TABLE_ROW::GetFullURI(), PLUGIN::GetLibraryTimestamp(), LIB_TABLE::GetLogicalLibs(), and FP_LIB_TABLE_ROW::plugin.

Referenced by FOOTPRINT_LIST_IMPL::ReadFootprintFiles().

GetCount()

unsigned LIB_TABLE::GetCount ( ) const

inlineinherited

Get the number of rows contained in the table.

Definition at line 366 of file lib_table_base.h.

 {
 return m_rows.size();
 }

References LIB_TABLE::m_rows.

Referenced by BOOST_AUTO_TEST_CASE(), FP_TREE_SYNCHRONIZING_ADAPTER::GetLibrariesCount(), LoadGlobalTable(), SYMBOL_LIB_TABLE::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 139 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().

GetEnumeratedFootprint()

const FOOTPRINT * FP_LIB_TABLE::GetEnumeratedFootprint	(	const wxString &	aNickname,
		const wxString &	aFootprintName
	)

A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management.

The return value is const to allow it to return a reference to a cached item.

Definition at line 359 of file fp_lib_table.cpp.

{
 const FP_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxASSERT( (PLUGIN*) row->plugin );
 
 return row->plugin->GetEnumeratedFootprint( row->GetFullURI( true ), aFootprintName,
 row->GetProperties() );
}

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

Referenced by FOOTPRINT_PREVIEW_PANEL::DisplayFootprint(), FOOTPRINT_INFO_GENERATOR::GenerateHtml(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), and FOOTPRINT_INFO_IMPL::load().

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

GetGlobalTableFileName()

wxString FP_LIB_TABLE::GetGlobalTableFileName ( )

static

Returns

the platform specific global footprint library path and file name.

Definition at line 645 of file fp_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 PCB_BASE_EDIT_FRAME::AddLibrary(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::GetGlobalTableFileName(), InvokePcbLibTableEditor(), PCB::IFACE::loadGlobalLibTable(), LoadGlobalTable(), and DIALOG_GLOBAL_FP_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 268 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->m_rows.begin(); it!=cur->m_rows.end(); ++it )
 {
 if( it->GetIsEnabled() )
 unique.insert( it->GetNickName() );
 }
 
 } while( ( cur = cur->m_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::m_fallBack, and LIB_TABLE::m_rows.

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

GetVersion()

int LIB_TABLE::GetVersion ( ) const

inlineinherited

Returns the version number (0 if unset)

Returns

integer version number read from table

Definition at line 519 of file lib_table_base.h.

 {
 return m_version;
 }

References LIB_TABLE::m_version.

GlobalPathEnvVariableName()

const wxString FP_LIB_TABLE::GlobalPathEnvVariableName ( )

static

Return the name of the environment variable used to hold the directory of locally installed "KiCad sponsored" system footprint libraries.

These can be either legacy or pretty format. The only thing special about this particular environment variable is that it is set automatically by KiCad on program start up, if it is not set already in the environment.

Definition at line 494 of file fp_lib_table.cpp.

{
 return wxS( "KICAD7_FOOTPRINT_DIR" );
}

Referenced by DIALOG_CONFIG_EQUFILES::Init(), and PANEL_FP_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 151 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(), 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 162 of file lib_table_base.cpp.

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

References LIB_TABLE::m_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 304 of file lib_table_base.cpp.

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

References LIB_TABLE::ensureIndex(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE::m_nickIndex, LIB_TABLE::m_nickIndexMutex, LIB_TABLE::m_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(), SYMBOL_LIB_TABLE::Parse(), and 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 130 of file lib_table_base.cpp.

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

References LIB_TABLE::IsEmpty(), LIB_TABLE::m_fallBack, and LIB_TABLE::m_rows.

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

IsFootprintLibWritable()

bool FP_LIB_TABLE::IsFootprintLibWritable

(

const wxString &

aNickname

)

Return true if the library given by aNickname is writable.

Often system libraries are read only because of where they are installed.

Exceptions

IO_ERROR

if no library at aLibraryPath exists.

Definition at line 438 of file fp_lib_table.cpp.

{
 const FP_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxASSERT( (PLUGIN*) row->plugin );
 return row->plugin->IsFootprintLibWritable( row->GetFullURI( true ) );
}

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

Referenced by FOOTPRINT_EDIT_FRAME::UpdateTitle().

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 356 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 );
 
 if( m_version != 7 && migrate() && wxFileName::IsFileWritable( aFileName ) )
 Save( aFileName );
 }
}

References LIB_TABLE::m_version, LIB_TABLE::migrate(), LIB_TABLE::Parse(), and LIB_TABLE::Save().

Referenced by LoadGlobalTable(), SYMBOL_LIB_TABLE::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 FP_LIB_TABLE::LoadGlobalTable ( FP_LIB_TABLE &  aTable )

static

Load the global footprint library table into aTable.

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

Parameters

aTable

the FP_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 footprint library table.

Definition at line 561 of file fp_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( "KICAD7_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 footprint table for the user to populate.
 if( fileName.IsEmpty() || !::wxCopyFile( fileName, fn.GetFullPath(), false ) )
 {
 FP_LIB_TABLE emptyTable;
 
 emptyTable.Save( fn.GetFullPath() );
 }
 }
 
 aTable.Clear();
 aTable.Load( fn.GetFullPath() );
 
 SETTINGS_MANAGER& mgr = Pgm().GetSettingsManager();
 KICAD_SETTINGS* settings = mgr.GetAppSettings<KICAD_SETTINGS>();
 
 wxString packagesPath = Pgm().GetLocalEnvVariables().at( wxT( "KICAD7_3RD_PARTY" ) ).GetValue();
 
 if( settings->m_PcmLibAutoAdd )
 {
 // Scan for libraries in PCM packages directory
 
 wxFileName d( packagesPath, wxS( "" ) );
 d.AppendDir( wxS( "footprints" ) );
 
 if( d.DirExists() )
 {
 PCM_FP_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 ) && !wxDir::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(), LIB_TABLE::Clear(), 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 PCB::IFACE::loadGlobalLibTable(), CV::IFACE::OnKifaceStart(), and DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow().

migrate()

bool LIB_TABLE::migrate ( )

protectedinherited

Updates the env vars from older version of KiCad, provided they do not currently resolve to anything.

Returns

True if the tables were modified

Definition at line 331 of file lib_table_base.cpp.

{
 bool table_updated = false;
 
 for( LIB_TABLE_ROW& row : m_rows )
 {
 bool row_updated = false;
 wxString uri = row.GetFullURI( true );
 
 // If the uri still has a variable in it, that means that the user does not have
 // these vars defined. We update the old vars to the KICAD7 versions on load
 row_updated |= ( uri.Replace( wxS( "${KICAD5_" ), wxS( "${KICAD7_" ), false ) > 0 );
 row_updated |= ( uri.Replace( wxS( "${KICAD6_" ), wxS( "${KICAD7_" ), false ) > 0 );
 
 if( row_updated )
 {
 row.SetFullURI( uri );
 table_updated = true;
 }
 }
 
 return table_updated;
}

References LIB_TABLE::m_rows.

Referenced by LIB_TABLE::Load().

operator!=() [1/2]

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

inline

Definition at line 117 of file fp_lib_table.h.

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

operator!=() [2/2]

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

inlineinherited

Definition at line 361 of file lib_table_base.h.

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

operator==() [1/2]

bool FP_LIB_TABLE::operator==

(

const FP_LIB_TABLE &

aFpTable

)

const

Definition at line 235 of file fp_lib_table.cpp.

{
 if( m_rows.size() == aFpTable.m_rows.size() )
 {
 for( unsigned i = 0; i < m_rows.size(); ++i )
 {
 if( (FP_LIB_TABLE_ROW&)m_rows[i] != (FP_LIB_TABLE_ROW&)aFpTable.m_rows[i] )
 return false;
 }
 
 return true;
 }
 
 return false;
}

References LIB_TABLE::m_rows.

operator==() [2/2]

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

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

References LIB_TABLE::m_rows.

Parse()

void FP_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 75 of file fp_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_fp_lib_table )
 {
 in->NeedLEFT();
 
 if( ( tok = in->NextTok() ) != T_fp_lib_table )
 in->Expecting( T_fp_lib_table );
 }
 
 while( ( tok = in->NextTok() ) != T_RIGHT )
 {
 std::unique_ptr<FP_LIB_TABLE_ROW> row = std::make_unique<FP_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();
 tok = in->NextTok();
 
 // Optionally parse the current version number
 if( tok == T_version )
 {
 in->NeedNUMBER( "version" );
 m_version = std::stoi( in->CurText() );
 in->NeedRIGHT();
 continue;
 }
 
 if( tok != 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;
 
 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:
 // Hiding footprint libraries is not yet supported. Unclear what path can set this
 // attribute, but clear it on load.
 row->SetVisible();
 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 "
 "footprint 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(), LIB_TABLE::m_version, and THROW_IO_ERROR.

Referenced by FP_GRID_TRICKS::paste_text().

ParseOptions()

STRING_UTF8_MAP * 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 382 of file lib_table_base.cpp.

{
 if( aOptionsList.size() )
 {
 const char* cp = &aOptionsList[0];
 const char* end = cp + aOptionsList.size();
 
 STRING_UTF8_MAP 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 STRING_UTF8_MAP( props );
 }
 
 return nullptr;
}

References name, and OPT_SEP.

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

PrefetchLib()

void FP_LIB_TABLE::PrefetchLib

(

const wxString &

aNickname

)

If possible, prefetches the specified library (e.g.

performing downloads). Does not parse. Threadsafe.

This is a no-op for libraries that cannot be prefetched.

Parameters

aNickname

is a locator for the library; it is a name in LIB_TABLE_ROW.

Exceptions

IO_ERROR

if there is an error prefetching the library.

Definition at line 302 of file fp_lib_table.cpp.

{
 const FP_LIB_TABLE_ROW* row = FindRow( aNickname, true );
 wxASSERT( (PLUGIN*) row->plugin );
 row->plugin->PrefetchLib( row->GetFullURI( true ), row->GetProperties() );
}

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

Referenced by FOOTPRINT_LIST_IMPL::loadLibs().

reindex()

void LIB_TABLE::reindex ( bool  aForce )

inlineprotectedinherited

Rebuilds the m_nickIndex.

Parameters

aForce

is to avoid rebuilding the index multiple times because multiple threads hit ensureIndex at the same time

Definition at line 549 of file lib_table_base.h.

 {
 std::lock_guard<std::shared_mutex> lock( m_nickIndexMutex );
 
 if( !aForce )
 {
 if( m_nickIndex.size() )
 return;
 }
 
 m_nickIndex.clear();
 
 for( LIB_TABLE_ROWS_ITER it = m_rows.begin(); it != m_rows.end(); ++it )
 m_nickIndex.insert( INDEX_VALUE( it->GetNickName(), it - m_rows.begin() ) );
 }

References LIB_TABLE::m_nickIndex, LIB_TABLE::m_nickIndexMutex, and LIB_TABLE::m_rows.

Referenced by LIB_TABLE::ensureIndex(), LIB_TABLE::RemoveRow(), 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 451 of file lib_table_base.h.

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

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

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary(), LoadGlobalTable(), and SYMBOL_LIB_TABLE::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 372 of file lib_table_base.cpp.

{
 FILE_OUTPUTFORMATTER sf( aFileName );
 
 // Force the lib table version to 7 before saving
 m_version = 7;
 Format( &sf, 0 );
}

References LIB_TABLE::Format(), and LIB_TABLE::m_version.

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), LIB_TABLE::Load(), LoadGlobalTable(), SYMBOL_LIB_TABLE::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().

Type()

KICAD_T FP_LIB_TABLE::Type ( )

inlineoverridevirtual

Implements PROJECT::_ELEM.

Definition at line 99 of file fp_lib_table.h.

{ return FP_LIB_TABLE_T; }

References FP_LIB_TABLE_T.

Referenced by PROJECT::PcbFootprintLibs().

Friends And Related Function Documentation

FP_LIB_TABLE_GRID

friend class FP_LIB_TABLE_GRID

friend

Definition at line 291 of file fp_lib_table.h.

Member Data Documentation

m_fallBack

LIB_TABLE* LIB_TABLE::m_fallBack

protectedinherited

Definition at line 590 of file lib_table_base.h.

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

m_nickIndex

INDEX LIB_TABLE::m_nickIndex

protectedinherited

this particular key is the nickName within each row.

Definition at line 588 of file lib_table_base.h.

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

m_nickIndexMutex

std::shared_mutex LIB_TABLE::m_nickIndexMutex

mutableprotectedinherited

Mutex to protect access to the nickIndex variable.

Definition at line 596 of file lib_table_base.h.

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

m_rows

LIB_TABLE_ROWS LIB_TABLE::m_rows

protectedinherited

Definition at line 579 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(), SYMBOL_LIB_TABLE::Format(), 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(), LIB_TABLE::migrate(), PANEL_SYM_LIB_TABLE::moveDownHandler(), PANEL_FP_LIB_TABLE::moveDownHandler(), PANEL_SYM_LIB_TABLE::moveUpHandler(), PANEL_FP_LIB_TABLE::moveUpHandler(), 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().

m_version

int LIB_TABLE::m_version

mutableprotectedinherited

Versioning to handle importing old tables.

Definition at line 593 of file lib_table_base.h.

Referenced by SYMBOL_LIB_TABLE::Format(), Format(), LIB_TABLE::GetVersion(), LIB_TABLE::Load(), SYMBOL_LIB_TABLE::Parse(), Parse(), and LIB_TABLE::Save().

---

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

• fp_lib_table.h
• fp_lib_table.cpp