#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 and frees the pointer. More...

bool	ReplaceRow (size_t aIndex, LIB_TABLE_ROW *aRow)
	Replaces the Nth row with the given new row. More...

bool	ChangeRowOrder (size_t aIndex, int aOffset)
	Moves a row within the table. More...

void	TransferRows (LIB_TABLE_ROWS &aRowsList)
	Takes ownership of another list of rows; the original list will be freed. 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 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 ()

Protected Attributes
LIB_TABLE *	m_fallBack

int	m_version
	Versioning to handle importing old tables. More...

LIB_TABLE_ROWS	m_rows
	Owning set of rows. More...

std::map< wxString, LIB_TABLE_ROWS_ITER >	m_rowsMap
	this is a non-owning index into the LIB_TABLE_ROWS table More...

std::shared_mutex	m_mutex
	Mutex to protect access to the rows vector. More...

Friends
class	FP_LIB_TABLE_GRID

Detailed Description

Definition at line 96 of file fp_lib_table.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.

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.

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

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

References LIB_TABLE::m_rows.

◆ ChangeRowOrder()

bool LIB_TABLE::ChangeRowOrder	(	size_t	aIndex,
		int	aOffset
	)

inherited

Moves a row within the table.

Parameters

aIndex	is the current index of the row to move
aOffset	is the number of positions to move it by in the table

Returns: true if the move resulted in a change

Definition at line 383 of file lib_table_base.cpp.

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

Referenced by PANEL_SYM_LIB_TABLE::moveDownHandler(), and PANEL_SYM_LIB_TABLE::moveUpHandler().

◆ Clear()

void LIB_TABLE::Clear ( )

inherited

Delete all rows.

Definition at line 130 of file lib_table_base.cpp.

References LIB_TABLE::m_rows, and LIB_TABLE::m_rowsMap.

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

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

References _, LIB_TABLE::findRow(), 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::buildFootprint3DShapes(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), BOARD_INSPECTION_TOOL::DiffFootprint(), 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(), PCB_BASE_FRAME::setFPWatcher(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow(), 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 194 of file lib_table_base.cpp.

References LIB_TABLE_ROW::GetIsEnabled(), LIB_TABLE::m_fallBack, LIB_TABLE::m_mutex, and LIB_TABLE::m_rowsMap.

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

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

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

Referenced by FOOTPRINT_EDIT_FRAME::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 301 of file fp_lib_table.cpp.

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

Referenced by 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 378 of file fp_lib_table.cpp.

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

Referenced by PCB_BASE_FRAME::CreateNewFootprint(), 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 462 of file fp_lib_table.cpp.

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

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

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 BOARD_INSPECTION_TOOL::DiffFootprint(), FootprintLoadWithOptionalNickname(), PCB_BASE_FRAME::OnFpChangeDebounceTimer(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), FOOTPRINT_VIEWER_FRAME::SelectAndViewFootprint(), and DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow().

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

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

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.

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

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

Referenced by DIALOG_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.

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

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

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), 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 367 of file fp_lib_table.cpp.

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

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

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(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow(), and WriteDRCReport().

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

References LIB_TABLE_ROW::GetIsEnabled(), LIB_TABLE_ROW::GetNickName(), LIB_TABLE::m_fallBack, and LIB_TABLE::m_rows.

Referenced by FP_TREE_MODEL_ADAPTER::AddLibraries(), CVPCB_MAINFRAME::BuildLibrariesList(), 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(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), 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 527 of file lib_table_base.h.

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

Referenced by DIALOG_CONFIG_EQUFILES::DIALOG_CONFIG_EQUFILES(), 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 158 of file lib_table_base.cpp.

References LIB_TABLE::findRow().

Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry(), BOARD_INSPECTION_TOOL::DiffFootprint(), EE_INSPECTION_TOOL::DiffSymbol(), 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::LoadSchematicFile(), CADSTAR_SCH_ARCHIVE_PLUGIN::LoadSchematicFile(), SCH_EAGLE_PLUGIN::LoadSchematicFile(), SCH_EASYEDAPRO_PLUGIN::LoadSchematicFile(), 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 169 of file lib_table_base.cpp.

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

References LIB_TABLE_ROW::GetNickName(), LIB_TABLE::m_mutex, LIB_TABLE::m_rows, LIB_TABLE::m_rowsMap, LIB_TABLE::reindex(), 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::LoadSchematicFile(), CADSTAR_SCH_ARCHIVE_PLUGIN::LoadSchematicFile(), SCH_EAGLE_PLUGIN::LoadSchematicFile(), SCH_EASYEDAPRO_PLUGIN::LoadSchematicFile(), 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 137 of file lib_table_base.cpp.

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

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

Referenced by FOOTPRINT_EDIT_FRAME::UpdateTitle().

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

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(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow(), and WriteDRCReport().

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

References _, SEARCH_STACK::AddPaths(), LIB_TABLE::At(), LIB_TABLE::Clear(), FindRow(), 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 426 of file lib_table_base.cpp.

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.

◆ operator!=() [2/2]

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

inlineinherited

Definition at line 362 of file lib_table_base.h.

◆ operator==() [1/2]

bool FP_LIB_TABLE::operator== ( const FP_LIB_TABLE & aFpTable ) const

Definition at line 235 of file fp_lib_table.cpp.

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

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.

References _, 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 477 of file lib_table_base.cpp.

References name, and OPT_SEP.

Referenced by PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries(), PANEL_FP_LIB_TABLE::onMigrateLibraries(), LIB_TABLE_ROW::SetOptions(), and DIALOG_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 311 of file fp_lib_table.cpp.

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

Referenced by FOOTPRINT_LIST_IMPL::loadLibs().

◆ reindex()

void LIB_TABLE::reindex ( )

protectedinherited

Definition at line 414 of file lib_table_base.cpp.

References LIB_TABLE::m_rows, and LIB_TABLE::m_rowsMap.

Referenced by LIB_TABLE::ChangeRowOrder(), LIB_TABLE::InsertRow(), LIB_TABLE::RemoveRow(), LIB_TABLE::ReplaceRow(), and LIB_TABLE::TransferRows().

◆ RemoveRow()

bool LIB_TABLE::RemoveRow ( const LIB_TABLE_ROW * aRow )

inherited

Removes a row from the table and frees the pointer.

Parameters

aRow	is the row to remove

Returns: true if the row was found (and removed)

Definition at line 331 of file lib_table_base.cpp.

References LIB_TABLE_ROW::GetNickName(), LIB_TABLE::m_mutex, LIB_TABLE::m_rows, LIB_TABLE::m_rowsMap, and LIB_TABLE::reindex().

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

◆ ReplaceRow()

bool LIB_TABLE::ReplaceRow	(	size_t	aIndex,
		LIB_TABLE_ROW *	aRow
	)

inherited

Replaces the Nth row with the given new row.

Returns: true if successful

Definition at line 368 of file lib_table_base.cpp.

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

Referenced by SYMBOL_GRID_TRICKS::paste_text().

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

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

◆ TransferRows()

void LIB_TABLE::TransferRows ( LIB_TABLE_ROWS & aRowsList )

inherited

Takes ownership of another list of rows; the original list will be freed.

Definition at line 404 of file lib_table_base.cpp.

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

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

◆ Type()

KICAD_T FP_LIB_TABLE::Type ( )

inlineoverridevirtual

Implements PROJECT::_ELEM.

Definition at line 99 of file fp_lib_table.h.

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

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

◆ m_mutex

std::shared_mutex LIB_TABLE::m_mutex

mutableprotectedinherited

Mutex to protect access to the rows vector.

Definition at line 568 of file lib_table_base.h.

Referenced by LIB_TABLE::ChangeRowOrder(), LIB_TABLE::findRow(), LIB_TABLE::InsertRow(), LIB_TABLE::RemoveRow(), LIB_TABLE::ReplaceRow(), and LIB_TABLE::TransferRows().

◆ m_rows

LIB_TABLE_ROWS LIB_TABLE::m_rows

protectedinherited

Owning set of rows.

Definition at line 562 of file lib_table_base.h.

◆ m_rowsMap

std::map<wxString, LIB_TABLE_ROWS_ITER> LIB_TABLE::m_rowsMap

protectedinherited

this is a non-owning index into the LIB_TABLE_ROWS table

Definition at line 565 of file lib_table_base.h.

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

◆ m_version

int LIB_TABLE::m_version

mutableprotectedinherited

Versioning to handle importing old tables.

Definition at line 557 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:

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ SAVE_T

Constructor & Destructor Documentation

◆ FP_LIB_TABLE()

Member Function Documentation

◆ At() [1/2]

◆ At() [2/2]

◆ ChangeRowOrder()

◆ Clear()

◆ FindRow()

◆ findRow()

◆ FindRowByURI()

◆ FootprintDelete()

◆ FootprintEnumerate()

◆ FootprintExists()

◆ FootprintLibCreate()

◆ FootprintLibDelete()

◆ FootprintLoad()

◆ FootprintLoadWithOptionalNickname()

◆ FootprintSave()

◆ Format()

◆ FormatOptions()

◆ GenerateTimestamp()

◆ GetCount()

◆ GetDescription()

◆ GetEnumeratedFootprint()

◆ GetFullURI()

◆ GetGlobalTableFileName()

◆ GetLogicalLibs()

◆ GetVersion()

◆ GlobalPathEnvVariableName()

◆ HasLibrary()

◆ HasLibraryWithPath()

◆ InsertRow()

◆ IsEmpty()

◆ IsFootprintLibWritable()

◆ Load()

◆ LoadGlobalTable()

◆ migrate()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ Parse()

◆ ParseOptions()

◆ PrefetchLib()

◆ reindex()

◆ RemoveRow()

◆ ReplaceRow()

◆ Save()

◆ TransferRows()

◆ Type()

Friends And Related Function Documentation

◆ FP_LIB_TABLE_GRID

Member Data Documentation

◆ m_fallBack

◆ m_mutex

◆ m_rows

◆ m_rowsMap

◆ m_version