SYMBOL_LIB_TABLE Class Reference

#include <symbol_lib_table.h>

Inheritance diagram for SYMBOL_LIB_TABLE:

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

Public Member Functions
PROJECT::ELEM	ProjectElementType () 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.
virtual void	Format (OUTPUTFORMATTER *aOutput, int aIndentLevel) const override
	Generate the table in s-expression format to aOutput with an indentation level of aIndentLevel.
	SYMBOL_LIB_TABLE (SYMBOL_LIB_TABLE *aFallBackTable=nullptr)
	Build a symbol library table by pre-pending this table fragment in front of aFallBackTable.
SYMBOL_LIB_TABLE_ROW *	FindRow (const wxString &aNickName, bool aCheckIfEnabled=false)
	Return an SYMBOL_LIB_TABLE_ROW if aNickName is found in this table or in any chained fallBack table fragment.
int	GetModifyHash ()
void	EnumerateSymbolLib (const wxString &aNickname, wxArrayString &aAliasNames, bool aPowerSymbolsOnly=false)
	Return a list of symbol alias names contained within the library given by aNickname.
void	LoadSymbolLib (std::vector< LIB_SYMBOL * > &aAliasList, const wxString &aNickname, bool aPowerSymbolsOnly=false)
LIB_SYMBOL *	LoadSymbol (const wxString &aNickname, const wxString &aName)
	Load a LIB_SYMBOL having aName from the library given by aNickname.
LIB_SYMBOL *	LoadSymbol (const LIB_ID &aLibId)
SAVE_T	SaveSymbol (const wxString &aNickname, const LIB_SYMBOL *aSymbol, bool aOverwrite=true)
	Write aSymbol to an existing library given by aNickname.
void	DeleteSymbol (const wxString &aNickname, const wxString &aSymbolName)
	Deletes the aSymbolName from the library given by aNickname.
bool	IsSymbolLibWritable (const wxString &aNickname)
	Return true if the library given by aNickname is writable.
bool	IsSymbolLibLoaded (const wxString &aNickname)
	Return true if the library given by aNickname was successfully loaded.
void	DeleteSymbolLib (const wxString &aNickname)
void	CreateSymbolLib (const wxString &aNickname)
LIB_SYMBOL *	LoadSymbolWithOptionalNickname (const LIB_ID &aId)
	Load a LIB_SYMBOL having aFootprintId with possibly an empty library nickname.
bool	operator== (const SYMBOL_LIB_TABLE &aOther) const
	Compares this table against another.
bool	operator!= (const SYMBOL_LIB_TABLE &aOther) const
bool	operator== (const LIB_TABLE &r) const
	Compares this table against another.
bool	operator!= (const LIB_TABLE &r) const
unsigned	GetCount () const
	Get the number of rows contained in the table.
LIB_TABLE_ROW &	At (unsigned aIndex)
	Get the 'n'th LIB_TABLE_ROW object.
const LIB_TABLE_ROW &	At (unsigned aIndex) const
	Get the 'n'th LIB_TABLE_ROW object.
bool	IsEmpty (bool aIncludeFallback=true)
	Return true if the table is empty.
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.
bool	HasLibraryWithPath (const wxString &aPath) const
	Test for the existence of aPath in the library table.
std::vector< wxString >	GetLogicalLibs ()
	Return the logical library names, all of them that are pertinent to a look up done on this LIB_TABLE.
wxString	GetFullURI (const wxString &aLibNickname, bool aExpandEnvVars=true) const
	Return the full URI of the library mapped to aLibNickname.
bool	InsertRow (LIB_TABLE_ROW *aRow, bool doReplace=false)
	Adds aRow if it does not already exist or if doReplace is true.
bool	RemoveRow (const LIB_TABLE_ROW *aRow)
	Removes a row from the table and frees the pointer.
bool	ReplaceRow (size_t aIndex, LIB_TABLE_ROW *aRow)
	Replaces the Nth row with the given new row.
bool	ChangeRowOrder (size_t aIndex, int aOffset)
	Moves a row within the table.
void	TransferRows (LIB_TABLE_ROWS &aRowsList)
	Takes ownership of another list of rows; the original list will be freed.
const LIB_TABLE_ROW *	FindRowByURI (const wxString &aURI)
void	Load (const wxString &aFileName)
	Load the library table using the path defined by aFileName aFallBackTable.
void	Save (const wxString &aFileName) const
	Write this library table to aFileName in s-expression form.
int	GetVersion () const
	Returns the version number (0 if unset)

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

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

Protected Member Functions
void	clear ()
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.
bool	doInsertRow (LIB_TABLE_ROW *aRow, bool doReplace=false)
	Performs the mechanics of inserting a row, but without locking or reindexing.
bool	migrate ()
	Updates the env vars from older version of KiCad, provided they do not currently resolve to anything.
void	reindex ()

Protected Attributes
std::unique_ptr< LIB_TABLE_IO >	m_io
LIB_TABLE *	m_fallBack
int	m_version
	Versioning to handle importing old tables.
LIB_TABLE_ROWS	m_rows
	Owning set of rows.
std::map< wxString, LIB_TABLE_ROWS_ITER >	m_rowsMap
	this is a non-owning index into the LIB_TABLE_ROWS table
std::shared_mutex	m_mutex
	Mutex to protect access to the rows vector.

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

Friends
class	SYMBOL_LIB_TABLE_GRID
class	PANEL_SYM_LIB_TABLE

Detailed Description

Definition at line 146 of file symbol_lib_table.h.

Member Enumeration Documentation

SAVE_T

enum SYMBOL_LIB_TABLE::SAVE_T

The set of return values from SaveSymbol() below.

Enumerator
SAVE_OK
SAVE_SKIPPED

Definition at line 219 of file symbol_lib_table.h.

Constructor & Destructor Documentation

SYMBOL_LIB_TABLE()

SYMBOL_LIB_TABLE::SYMBOL_LIB_TABLE

(

SYMBOL_LIB_TABLE *

aFallBackTable = nullptr

)

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

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

Parameters

aFallBackTable

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

Definition at line 128 of file symbol_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 435 of file lib_table_base.h.

Referenced by DESIGN_BLOCK_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), LoadGlobalTable(), DESIGN_BLOCK_GRID_TRICKS::paste_text(), 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 443 of file lib_table_base.h.

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

protectedinherited

Definition at line 186 of file lib_table_base.cpp.

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

Referenced by LIB_TABLE::Load(), DESIGN_BLOCK_LIB_TABLE::LoadGlobalTable(), and LIB_TABLE::TransferRows().

CreateSymbolLib()

void SYMBOL_LIB_TABLE::CreateSymbolLib

(

const wxString &

aNickname

)

Definition at line 517 of file symbol_lib_table.cpp.

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

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary().

DeleteSymbol()

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

Deletes the aSymbolName from the library given by aNickname.

Parameters

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

Exceptions

IO_ERROR

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

Definition at line 486 of file symbol_lib_table.cpp.

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

DeleteSymbolLib()

void SYMBOL_LIB_TABLE::DeleteSymbolLib

(

const wxString &

aNickname

)

Definition at line 509 of file symbol_lib_table.cpp.

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

doInsertRow()

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

protectedinherited

Performs the mechanics of inserting a row, but without locking or reindexing.

Definition at line 361 of file lib_table_base.cpp.

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

Referenced by LIB_TABLE::InsertRow(), Parse(), DESIGN_BLOCK_LIB_TABLE::Parse(), and FP_LIB_TABLE::Parse().

EnumerateSymbolLib()

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

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

Parameters

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

Exceptions

IO_ERROR

if the library cannot be found or loaded.

Definition at line 339 of file symbol_lib_table.cpp.

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

Referenced by SYMBOL_LIBRARY_MANAGER::getOriginalSymbols(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), and SYMBOL_VIEWER_FRAME::ReCreateLibList().

FindRow()

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

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

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

Parameters

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

Returns

the row found or NULL if aNickName was not found.

Definition at line 359 of file symbol_lib_table.cpp.

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), CreateSymbolLib(), DeleteSymbol(), DeleteSymbolLib(), EE_INSPECTION_TOOL::DiffSymbol(), SYMBOL_VIEWER_FRAME::DisplayLibInfos(), EnumerateSymbolLib(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SYMBOL_LIBRARY_MANAGER::GetLibrary(), GetModifyHash(), IsSymbolLibLoaded(), IsSymbolLibWritable(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_VIEWER_FRAME::KiwayMailIn(), LoadGlobalTable(), SCH_EDIT_FRAME::LoadSheetFromFile(), LoadSymbol(), LoadSymbolLib(), SYMBOL_LIB_TABLE_RESCUER::OpenRescueLibrary(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SaveSymbol(), SCH_BASE_FRAME::setSymWatcher(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), ERC_TESTER::TestLibSymbolIssues(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

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 250 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 FindRow(), DESIGN_BLOCK_LIB_TABLE::FindRow(), FP_LIB_TABLE::FindRow(), LIB_TABLE::GetDescription(), LIB_TABLE::GetFullURI(), and LIB_TABLE::HasLibrary().

FindRowByURI()

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

inherited

Returns

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

Definition at line 293 of file lib_table_base.cpp.

References LIB_TABLE::m_fallBack, LIB_TABLE::m_io, and LIB_TABLE::m_rows.

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

Format()

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

overridevirtual

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

Parameters

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

Exceptions

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

Implements LIB_TABLE.

Definition at line 304 of file symbol_lib_table.cpp.

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

Referenced by DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_IO_ALTIUM::LoadSchematicFile(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EAGLE::LoadSchematicFile(), and SCH_IO_EASYEDAPRO::LoadSchematicFile().

FormatOptions()

UTF8 LIB_TABLE::FormatOptions ( const std::map< std::string, UTF8 > *  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 606 of file lib_table_base.cpp.

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

Referenced by DIALOG_PLUGIN_OPTIONS::TransferDataFromWindow().

GetCount()

unsigned LIB_TABLE::GetCount ( ) const

inlineinherited

Get the number of rows contained in the table.

Definition at line 425 of file lib_table_base.h.

Referenced by FP_TREE_SYNCHRONIZING_ADAPTER::GetLibrariesCount(), DESIGN_BLOCK_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), LoadGlobalTable(), DESIGN_BLOCK_GRID_TRICKS::paste_text(), 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 202 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().

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 237 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(), FOOTPRINT_EDITOR_CONTROL::SaveAs(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), and SYMBOL_EDIT_FRAME::saveLibrary().

GetGlobalLibTable()

SYMBOL_LIB_TABLE & SYMBOL_LIB_TABLE::GetGlobalLibTable ( )

static

Definition at line 136 of file symbol_lib_table.cpp.

References g_symbolLibraryTable.

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

GetGlobalTableFileName()

wxString SYMBOL_LIB_TABLE::GetGlobalTableFileName ( )

static

Fetch the global symbol library table file name.

Returns

the platform specific global symbol library path and file name.

Definition at line 741 of file symbol_lib_table.cpp.

References PATHS::GetUserSettingsPath(), and global_tbl_name.

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

GetLogicalLibs()

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

inherited

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

Definition at line 314 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 DESIGN_BLOCK_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), CVPCB_MAINFRAME::BuildLibrariesList(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), DESIGN_BLOCK_LIB_TABLE::DesignBlockLoadWithOptionalNickname(), FP_LIB_TABLE::FootprintLoadWithOptionalNickname(), DESIGN_BLOCK_LIB_TABLE::GenerateTimestamp(), FP_LIB_TABLE::GenerateTimestamp(), GetFootprintLibraries(), SYMBOL_LIBRARY_MANAGER::GetLibraryCount(), GetModifyHash(), guessNickname(), SYMBOL_VIEWER_FRAME::loadAllLibraries(), CVPCB_MAINFRAME::LoadFootprintFiles(), LoadSymbolWithOptionalNickname(), FOOTPRINT_VIEWER_FRAME::OnActivate(), DIALOG_EDIT_SYMBOLS_LIBID::onClickOrphansButton(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), DESIGN_BLOCK_LIST_IMPL::ReadDesignBlockFiles(), FOOTPRINT_LIST_IMPL::ReadFootprintFiles(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), SAVE_AS_DIALOG::SAVE_AS_DIALOG(), PCB_BASE_FRAME::SelectLibrary(), SCH_BASE_FRAME::SelectLibraryFromList(), and FP_TREE_SYNCHRONIZING_ADAPTER::Sync().

GetModifyHash()

int SYMBOL_LIB_TABLE::GetModifyHash

(

)

Definition at line 316 of file symbol_lib_table.cpp.

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

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

GetSymbolLibTableFileName()

const wxString & SYMBOL_LIB_TABLE::GetSymbolLibTableFileName ( )

static

Definition at line 752 of file symbol_lib_table.cpp.

References global_tbl_name.

Referenced by SYMBOL_EDIT_FRAME::addLibTableEntry(), DIALOG_SYMBOL_REMAP::backupProject(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), InvokeSchEditSymbolLibTable(), SCH_IO_ALTIUM::LoadSchematicFile(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EAGLE::LoadSchematicFile(), SCH_IO_EASYEDAPRO::LoadSchematicFile(), SCH_EDIT_FRAME::LoadSheetFromFile(), DIALOG_SYMBOL_REMAP::OnRemapSymbols(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), SCH_BASE_FRAME::saveSymbolLibTables(), PROJECT_SCH::SchSymbolLibTable(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

GetVersion()

int LIB_TABLE::GetVersion ( ) const

inlineinherited

Returns the version number (0 if unset)

Returns

integer version number read from table

Definition at line 585 of file lib_table_base.h.

GlobalPathEnvVariableName()

const wxString SYMBOL_LIB_TABLE::GlobalPathEnvVariableName ( )

static

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

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

Definition at line 555 of file symbol_lib_table.cpp.

References ENV_VAR::GetVersionedEnvVarName().

Referenced by PANEL_SYM_LIB_TABLE::populateEnvironReadOnlyTable().

HasLibrary()

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

inherited

Test for the existence of aNickname in the library table.

Parameters

aCheckEnabled

if true will only return true for enabled libraries

Returns

true if a library aNickname exists in the table.

Definition at line 214 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(), CV::kiface(), SYMBOL_EDIT_FRAME::KiwayMailIn(), FOOTPRINT_EDIT_FRAME::KiwayMailIn(), SYMBOL_LIBRARY_MANAGER::LibraryExists(), SCH_IO_ALTIUM::LoadSchematicFile(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EAGLE::LoadSchematicFile(), SCH_IO_EASYEDAPRO::LoadSchematicFile(), SCH_EDIT_FRAME::LoadSheetFromFile(), NETLIST_EXPORTER_XML::makeLibraries(), PCM_DESIGN_BLOCK_LIB_TRAVERSER::OnDir(), PCM_FP_LIB_TRAVERSER::OnDir(), PCM_SYM_LIB_TRAVERSER::OnFile(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), DRC_TEST_PROVIDER_LIBRARY_PARITY::Run(), SYMBOL_EDIT_FRAME::saveLibrary(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), 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 225 of file lib_table_base.cpp.

References LIB_TABLE::m_rows.

Referenced by PCM_DESIGN_BLOCK_LIB_TRAVERSER::OnDir(), 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 350 of file lib_table_base.cpp.

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

Referenced by SCH_EDIT_FRAME::AddDesignBlockLibrary(), SYMBOL_LIBRARY_MANAGER::addLibrary(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable(), SCH_IO_ALTIUM::LoadSchematicFile(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EAGLE::LoadSchematicFile(), SCH_IO_EASYEDAPRO::LoadSchematicFile(), SCH_EDIT_FRAME::LoadSheetFromFile(), PCM_DESIGN_BLOCK_LIB_TRAVERSER::OnDir(), PCM_FP_LIB_TRAVERSER::OnDir(), PCM_SYM_LIB_TRAVERSER::OnFile(), PCB_EDIT_FRAME::OpenProjectFiles(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

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

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

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

IsSymbolLibLoaded()

bool SYMBOL_LIB_TABLE::IsSymbolLibLoaded

(

const wxString &

aNickname

)

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

Parameters

aNickname

is the library nickname in the symbol library table.

Exceptions

IO_ERROR

if no library at aNickname exists.

Definition at line 501 of file symbol_lib_table.cpp.

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

Referenced by SYMBOL_LIBRARY_MANAGER::IsLibraryLoaded().

IsSymbolLibWritable()

bool SYMBOL_LIB_TABLE::IsSymbolLibWritable

(

const wxString &

aNickname

)

Return true if the library given by aNickname is writable.

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

Parameters

aNickname

is the library nickname in the symbol library table.

Exceptions

IO_ERROR

if no library at aNickname exists.

Definition at line 494 of file symbol_lib_table.cpp.

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

Referenced by SYMBOL_LIBRARY_MANAGER::IsLibraryReadOnly().

Load()

void LIB_TABLE::Load ( const wxString &  aFileName )

inherited

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

Parameters

aFileName

contains the full path to the s-expression file.

Exceptions

IO_ERROR

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

Definition at line 504 of file lib_table_base.cpp.

References LIB_TABLE::clear(), LIB_TABLE::m_io, LIB_TABLE::m_mutex, LIB_TABLE::m_version, LIB_TABLE::migrate(), LIB_TABLE::Parse(), LIB_TABLE::reindex(), and LIB_TABLE::Save().

Referenced by PROJECT::DesignBlockLibs(), DESIGN_BLOCK_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), LoadGlobalTable(), SCH_EDIT_FRAME::LoadSheetFromFile(), PROJECT::PcbFootprintLibs(), PROJECT_PCB::PcbFootprintLibs(), PCB::IFACE::SaveFileAs(), PROJECT_SCH::SchSymbolLibTable(), DIALOG_GLOBAL_DESIGN_BLOCK_LIB_TABLE_CONFIG::TransferDataFromWindow(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow(), and WriteDRCReport().

LoadGlobalTable()

bool SYMBOL_LIB_TABLE::LoadGlobalTable ( SYMBOL_LIB_TABLE &  aTable )

static

Load the global symbol library table into aTable.

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

Parameters

aTable

the SYMBOL_LIB_TABLE object to load.

Returns

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

Exceptions

IO_ERROR

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

Definition at line 626 of file symbol_lib_table.cpp.

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

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

LoadSymbol() [1/2]

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

inline

Definition at line 211 of file symbol_lib_table.h.

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

LoadSymbol() [2/2]

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

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

Parameters

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

Returns

the symbol alias if found or NULL if not found.

Exceptions

IO_ERROR

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

Definition at line 416 of file symbol_lib_table.cpp.

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

Referenced by EE_INSPECTION_TOOL::DiffSymbol(), SYMBOL_PREVIEW_WIDGET::DisplaySymbol(), FOOTPRINT_INFO_GENERATOR::GenerateHtml(), SYMBOL_LIBRARY_MANAGER::GetAlias(), SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), SYMBOL_LIBRARY_MANAGER::getOriginalSymbols(), SYMBOL_VIEWER_FRAME::GetSelectedSymbol(), SCH_IO_EAGLE::loadInstance(), LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), SCH_IO_DATABASE::loadSymbolFromRow(), LoadSymbolWithOptionalNickname(), PANEL_SYMBOL_CHOOSER::populateFootprintSelector(), SchGetLibSymbol(), PANEL_SYMBOL_CHOOSER::showFootprintFor(), SYMBOL_LIBRARY_MANAGER::SymbolExists(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), and SCH_SCREEN::UpdateSymbolLinks().

LoadSymbolLib()

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

Definition at line 379 of file symbol_lib_table.cpp.

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibrary(), SYMBOL_LIBRARY_MANAGER::GetAliases(), SYMBOL_LIB_TABLE_RESCUER::OpenRescueLibrary(), SYMBOL_VIEWER_FRAME::ReCreateSymbolList(), and SYMBOL_ASYNC_LOADER::worker().

LoadSymbolWithOptionalNickname()

LIB_SYMBOL * SYMBOL_LIB_TABLE::LoadSymbolWithOptionalNickname

(

const LIB_ID &

aId

)

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

Parameters

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

Returns

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

Exceptions

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

Definition at line 525 of file symbol_lib_table.cpp.

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

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

References LIB_TABLE::m_rows.

Referenced by LIB_TABLE::Load().

operator!=() [1/2]

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

inlineinherited

Definition at line 420 of file lib_table_base.h.

operator!=() [2/2]

bool SYMBOL_LIB_TABLE::operator!= ( const SYMBOL_LIB_TABLE &  aOther ) const

inline

Definition at line 330 of file symbol_lib_table.h.

operator==() [1/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 404 of file lib_table_base.h.

References LIB_TABLE::m_rows.

operator==() [2/2]

bool SYMBOL_LIB_TABLE::operator==

(

const SYMBOL_LIB_TABLE &

aOther

)

const

Compares this table against another.

This compares the row contents against each other.

Definition at line 721 of file symbol_lib_table.cpp.

References LIB_TABLE::m_rows.

Parse()

void SYMBOL_LIB_TABLE::Parse ( LIB_TABLE_LEXER *  aLexer )

overridevirtual

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

Parameters

aLexer

is the lexer to parse.

Exceptions

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

Implements LIB_TABLE.

Definition at line 142 of file symbol_lib_table.cpp.

References _, LIB_TABLE::doInsertRow(), LIB_TABLE::m_version, and THROW_IO_ERROR.

Referenced by SYMBOL_GRID_TRICKS::paste_text().

ParseOptions()

std::map< std::string, UTF8 > * 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 541 of file lib_table_base.cpp.

References name, and OPT_SEP.

Referenced by PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries(), PANEL_DESIGN_BLOCK_LIB_TABLE::onMigrateLibraries(), PANEL_FP_LIB_TABLE::onMigrateLibraries(), LIB_TABLE_ROW::SetOptions(), and DIALOG_PLUGIN_OPTIONS::TransferDataToWindow().

ProjectElementType()

PROJECT::ELEM SYMBOL_LIB_TABLE::ProjectElementType ( )

inlineoverridevirtual

Implements PROJECT::_ELEM.

Definition at line 149 of file symbol_lib_table.h.

References PROJECT::SYMBOL_LIB_TABLE.

Referenced by PROJECT_SCH::SchSymbolLibTable().

reindex()

void LIB_TABLE::reindex ( )

protectedinherited

Definition at line 467 of file lib_table_base.cpp.

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

Referenced by LIB_TABLE::ChangeRowOrder(), LIB_TABLE::doInsertRow(), LIB_TABLE::InsertRow(), LIB_TABLE::Load(), 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 383 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(), DESIGN_BLOCK_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), and 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 420 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 526 of file lib_table_base.cpp.

References _, LIB_TABLE::Format(), LIB_TABLE::m_io, LIB_TABLE::m_version, and THROW_IO_ERROR.

Referenced by SCH_EDIT_FRAME::AddDesignBlockLibrary(), PCB_BASE_EDIT_FRAME::AddLibrary(), SYMBOL_EDIT_FRAME::addLibTableEntry(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), InvokeEditDesignBlockLibTable(), InvokePcbLibTableEditor(), InvokeSchEditSymbolLibTable(), LIB_TABLE::Load(), SCH::IFACE::loadGlobalDesignBlockLibTable(), DESIGN_BLOCK_LIB_TABLE::LoadGlobalTable(), FP_LIB_TABLE::LoadGlobalTable(), LoadGlobalTable(), SCH_EDIT_FRAME::LoadSheetFromFile(), PCB_EDIT_FRAME::OpenProjectFiles(), SYMBOL_EDIT_FRAME::replaceLibTableEntry(), PCB::IFACE::SaveFileAs(), SCH_BASE_FRAME::saveSymbolLibTables(), DIALOG_GLOBAL_DESIGN_BLOCK_LIB_TABLE_CONFIG::TransferDataFromWindow(), DIALOG_GLOBAL_SYM_LIB_TABLE_CONFIG::TransferDataFromWindow(), DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

SaveSymbol()

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

Write aSymbol to an existing library given by aNickname.

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

Parameters

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

Returns

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

Exceptions

IO_ERROR

if there is a problem saving the symbol.

Definition at line 450 of file symbol_lib_table.cpp.

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

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

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

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

Friends And Related Function Documentation

PANEL_SYM_LIB_TABLE

friend class PANEL_SYM_LIB_TABLE

friend

Definition at line 335 of file symbol_lib_table.h.

SYMBOL_LIB_TABLE_GRID

friend class SYMBOL_LIB_TABLE_GRID

friend

Definition at line 334 of file symbol_lib_table.h.

Member Data Documentation

m_fallBack

LIB_TABLE* LIB_TABLE::m_fallBack

protectedinherited

Definition at line 628 of file lib_table_base.h.

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

m_io

std::unique_ptr<LIB_TABLE_IO> LIB_TABLE::m_io

protectedinherited

Definition at line 626 of file lib_table_base.h.

Referenced by LIB_TABLE::FindRowByURI(), LIB_TABLE::LIB_TABLE(), LIB_TABLE::Load(), and LIB_TABLE::Save().

m_modifyHash

int SYMBOL_LIB_TABLE::m_modifyHash = 1

staticprivate

helper for GetModifyHash()

Definition at line 337 of file symbol_lib_table.h.

Referenced by GetModifyHash().

m_mutex

std::shared_mutex LIB_TABLE::m_mutex

mutableprotectedinherited

Mutex to protect access to the rows vector.

Definition at line 642 of file lib_table_base.h.

Referenced by LIB_TABLE::ChangeRowOrder(), LIB_TABLE::findRow(), LIB_TABLE::InsertRow(), LIB_TABLE::Load(), 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 636 of file lib_table_base.h.

Referenced by DESIGN_BLOCK_LIB_TABLE_GRID::at(), SYMBOL_LIB_TABLE_GRID::at(), FP_LIB_TABLE_GRID::at(), DESIGN_BLOCK_LIB_TABLE_GRID::begin(), SYMBOL_LIB_TABLE_GRID::begin(), FP_LIB_TABLE_GRID::begin(), LIB_TABLE::ChangeRowOrder(), LIB_TABLE::clear(), DESIGN_BLOCK_LIB_TABLE_GRID::DESIGN_BLOCK_LIB_TABLE_GRID(), LIB_TABLE::doInsertRow(), DESIGN_BLOCK_LIB_TABLE_GRID::erase(), SYMBOL_LIB_TABLE_GRID::erase(), FP_LIB_TABLE_GRID::erase(), LIB_TABLE::FindRowByURI(), Format(), DESIGN_BLOCK_LIB_TABLE::Format(), FP_LIB_TABLE::Format(), FP_LIB_TABLE_GRID::FP_LIB_TABLE_GRID(), LIB_TABLE::GetLogicalLibs(), LIB_TABLE::HasLibraryWithPath(), DESIGN_BLOCK_LIB_TABLE_GRID::insert(), SYMBOL_LIB_TABLE_GRID::insert(), FP_LIB_TABLE_GRID::insert(), LIB_TABLE::IsEmpty(), LIB_TABLE::migrate(), PANEL_DESIGN_BLOCK_LIB_TABLE::moveDownHandler(), PANEL_SYM_LIB_TABLE::moveDownHandler(), PANEL_FP_LIB_TABLE::moveDownHandler(), PANEL_DESIGN_BLOCK_LIB_TABLE::moveUpHandler(), PANEL_FP_LIB_TABLE::moveUpHandler(), DESIGN_BLOCK_LIB_TABLE::operator==(), FP_LIB_TABLE::operator==(), LIB_TABLE::operator==(), operator==(), DESIGN_BLOCK_GRID_TRICKS::paste_text(), FP_GRID_TRICKS::paste_text(), DESIGN_BLOCK_LIB_TABLE_GRID::push_back(), SYMBOL_LIB_TABLE_GRID::push_back(), FP_LIB_TABLE_GRID::push_back(), LIB_TABLE::reindex(), LIB_TABLE::RemoveRow(), LIB_TABLE::ReplaceRow(), DESIGN_BLOCK_LIB_TABLE_GRID::size(), SYMBOL_LIB_TABLE_GRID::size(), FP_LIB_TABLE_GRID::size(), SYMBOL_LIB_TABLE_GRID::SYMBOL_LIB_TABLE_GRID(), and LIB_TABLE::TransferRows().

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

Referenced by LIB_TABLE::clear(), LIB_TABLE::doInsertRow(), LIB_TABLE::findRow(), 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 631 of file lib_table_base.h.

Referenced by Format(), DESIGN_BLOCK_LIB_TABLE::Format(), FP_LIB_TABLE::Format(), LIB_TABLE::Load(), Parse(), DESIGN_BLOCK_LIB_TABLE::Parse(), FP_LIB_TABLE::Parse(), and LIB_TABLE::Save().

PropNonPowerSymsOnly

const char * SYMBOL_LIB_TABLE::PropNonPowerSymsOnly = "non_pwr_sym_only"

static

Definition at line 152 of file symbol_lib_table.h.

PropPowerSymsOnly

const char * SYMBOL_LIB_TABLE::PropPowerSymsOnly = "pwr_sym_only"

static

Definition at line 151 of file symbol_lib_table.h.

Referenced by SCH_IO_ALTIUM::doEnumerateSymbolLib(), EnumerateSymbolLib(), SCH_IO_DATABASE::EnumerateSymbolLib(), SCH_IO_HTTP_LIB::EnumerateSymbolLib(), SCH_IO_KICAD_LEGACY::EnumerateSymbolLib(), SCH_IO_KICAD_SEXPR::EnumerateSymbolLib(), and LoadSymbolLib().

---

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

• symbol_lib_table.h
• symbol_lib_table.cpp