KiCad PCB EDA Suite
|
#include <fp_lib_table.h>
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 |
Definition at line 96 of file fp_lib_table.h.
|
protectedinherited |
this is a non-owning index into the LIB_TABLE_ROWS table
Definition at line 582 of file lib_table_base.h.
|
protectedinherited |
Definition at line 584 of file lib_table_base.h.
|
protectedinherited |
Definition at line 583 of file lib_table_base.h.
|
protectedinherited |
Definition at line 585 of file lib_table_base.h.
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.
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().
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.
|
inlineinherited |
Get the 'n'th LIB_TABLE_ROW object.
aIndex | index of row (must exist: from 0 to GetCount() - 1) |
Definition at line 376 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().
|
inlineinherited |
Get the 'n'th LIB_TABLE_ROW object.
aIndex | index of row (must exist: from 0 to GetCount() - 1) |
Definition at line 384 of file lib_table_base.h.
References LIB_TABLE::m_rows.
|
inlineinherited |
Delete all rows.
Definition at line 331 of file lib_table_base.h.
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().
|
inlineprotectedinherited |
Definition at line 565 of file lib_table_base.h.
References LIB_TABLE::m_nickIndex, and LIB_TABLE::reindex().
Referenced by LIB_TABLE::findRow(), LIB_TABLE::FindRowByURI(), and LIB_TABLE::InsertRow().
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.
aNickName | is the name of library nickname to find. |
aCheckIfEnabled | is the flag to check if the library found is enabled. |
IO_ERROR | if aNickName cannot be found. |
Definition at line 310 of file fp_lib_table.cpp.
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().
|
protectedinherited |
Return a LIB_TABLE_ROW if aNickname is found in this table or in any chained fallBack table fragment, else NULL.
aNickname | is the name of the library table entry to find. |
aCheckIfEnabled | is a flag to check if the library table entry is enabled. |
Definition at line 187 of file lib_table_base.cpp.
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().
|
inherited |
Definition at line 232 of file lib_table_base.cpp.
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().
void FP_LIB_TABLE::FootprintDelete | ( | const wxString & | aNickname, |
const wxString & | aFootprintName | ||
) |
Delete the aFootprintName from the library given by aNickname.
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. |
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.
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().
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.
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. |
IO_ERROR | if the library cannot be found, or footprint cannot be loaded. |
Definition at line 292 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().
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.
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().
void FP_LIB_TABLE::FootprintLibCreate | ( | const wxString & | aNickname | ) |
Definition at line 454 of file fp_lib_table.cpp.
References FindRow(), PLUGIN::FootprintLibCreate(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetProperties(), and FP_LIB_TABLE_ROW::plugin.
void FP_LIB_TABLE::FootprintLibDelete | ( | const wxString & | aNickname | ) |
Definition at line 446 of file fp_lib_table.cpp.
References FindRow(), PLUGIN::FootprintLibDelete(), LIB_TABLE_ROW::GetFullURI(), LIB_TABLE_ROW::GetProperties(), and FP_LIB_TABLE_ROW::plugin.
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.
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 |
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.
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().
FOOTPRINT * FP_LIB_TABLE::FootprintLoadWithOptionalNickname | ( | const LIB_ID & | aFootprintId, |
bool | aKeepUUID = false |
||
) |
Load a footprint having aFootprintId with possibly an empty nickname.
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 |
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.
References FootprintLoad(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), and LIB_TABLE::GetLogicalLibs().
Referenced by PCB_BASE_FRAME::loadFootprint().
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.
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. |
IO_ERROR | if there is a problem saving. |
Definition at line 402 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().
|
overridevirtual |
Generate the table in s-expression format to aOutput with an indentation level of aIndentLevel.
aOutput | is the OUTPUTFORMATTER to format the table into. |
aIndentLevel | is the indentation level (2 spaces) to indent. |
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().
|
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.
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.
References UTF8::begin(), UTF8::end(), name, OPT_SEP, and UTF8::size().
Referenced by DIALOG_FP_PLUGIN_OPTIONS::TransferDataFromWindow().
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().
|
inlineinherited |
Get the number of rows contained in the table.
Definition at line 366 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().
|
inherited |
Definition at line 139 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(), FOOTPRINT_EDIT_FRAME::buildSaveAsDialog(), SYMBOL_EDIT_FRAME::buildSaveAsDialog(), and PCB_BASE_FRAME::SelectLibrary().
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.
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().
|
inherited |
Return the full URI of the library mapped to aLibNickname.
Definition at line 174 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().
|
static |
Definition at line 645 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(), and DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow().
|
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.
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().
|
inlineinherited |
Returns the version number (0 if unset)
Definition at line 519 of file lib_table_base.h.
References LIB_TABLE::m_version.
|
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.
Referenced by DIALOG_CONFIG_EQUFILES::Init(), and PANEL_FP_LIB_TABLE::populateEnvironReadOnlyTable().
|
inherited |
Test for the existence of aNickname in the library table.
aCheckEnabled | if true will only return true for enabled libraries |
Definition at line 151 of file lib_table_base.cpp.
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().
|
inherited |
Test for the existence of aPath in the library table.
aCheckEnabled | if true will only return true for enabled libraries |
Definition at line 162 of file lib_table_base.cpp.
References LIB_TABLE::m_rows.
Referenced by PCM_FP_LIB_TRAVERSER::OnDir(), and PCM_SYM_LIB_TRAVERSER::OnFile().
|
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.
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. |
Definition at line 304 of file lib_table_base.cpp.
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().
|
inherited |
Return true if the table is empty.
aIncludeFallback | is used to determine if the fallback table should be included in the test. |
Definition at line 130 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().
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.
IO_ERROR | if no library at aLibraryPath exists. |
Definition at line 438 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().
|
inherited |
Load the library table using the path defined by aFileName aFallBackTable.
aFileName | contains the full path to the s-expression file. |
IO_ERROR | if an error occurs attempting to load the footprint library table. |
Definition at line 356 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(), and DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG::TransferDataFromWindow().
|
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.
aTable | the FP_LIB_TABLE object to load. |
IO_ERROR | if an error occurs attempting to load the footprint library table. |
Definition at line 561 of file fp_lib_table.cpp.
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().
|
protectedinherited |
Updates the env vars from older version of KiCad, provided they do not currently resolve to anything.
Definition at line 331 of file lib_table_base.cpp.
References LIB_TABLE::m_rows.
Referenced by LIB_TABLE::Load().
|
inline |
Definition at line 117 of file fp_lib_table.h.
|
inlineinherited |
Definition at line 361 of file lib_table_base.h.
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.
|
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.
References LIB_TABLE::m_rows.
|
overridevirtual |
Parse the #LIB_TABLE_LEXER s-expression library table format into the appropriate LIB_TABLE_ROW objects.
aLexer | is the lexer to parse. |
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 _, Format(), LIB_TABLE::InsertRow(), LIB_TABLE::m_version, and THROW_IO_ERROR.
Referenced by FP_GRID_TRICKS::paste_text().
|
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.
Referenced by LIB_TABLE_ROW::SetOptions(), and DIALOG_FP_PLUGIN_OPTIONS::TransferDataToWindow().
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.
aNickname | is a locator for the library; it is a name in LIB_TABLE_ROW. |
IO_ERROR | if there is an error prefetching the library. |
Definition at line 302 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().
|
inlineprotectedinherited |
Rebuilds the m_nickIndex.
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.
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().
|
inlineinherited |
Removes a row from the table.
aRow | is the row to remove |
Definition at line 451 of file lib_table_base.h.
References LIB_TABLE::m_rows, and LIB_TABLE::reindex().
Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary(), LoadGlobalTable(), and SYMBOL_LIB_TABLE::LoadGlobalTable().
|
inherited |
Write this library table to aFileName in s-expression form.
aFileName | is the name of the file to write to. |
Definition at line 372 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().
|
inlineoverridevirtual |
Implements PROJECT::_ELEM.
Definition at line 99 of file fp_lib_table.h.
References FP_LIB_TABLE_T.
Referenced by PROJECT::PcbFootprintLibs().
|
friend |
Definition at line 291 of file fp_lib_table.h.
|
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().
|
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().
|
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().
|
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().
|
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().