A collection of SYMBOL_LIB objects. More...

#include <symbol_library.h>

Inheritance diagram for SYMBOL_LIBS:

Public Member Functions
KICAD_T	Type () override

	SYMBOL_LIBS ()

SYMBOL_LIB *	AddLibrary (const wxString &aFileName)
	Allocate and adds a symbol library to the library list. More...

SYMBOL_LIB *	AddLibrary (const wxString &aFileName, SYMBOL_LIBS::iterator &aIterator)
	Insert a symbol library into the library list. More...

bool	ReloadLibrary (const wxString &aFileName)
	Refreshes the library from the (possibly updated) contents on disk. More...

void	LoadAllLibraries (PROJECT *aProject, bool aShowProgress=true)
	Load all of the project's libraries into this container, which should be cleared before calling it. More...

SYMBOL_LIB *	FindLibrary (const wxString &aName)
	Find a symbol library by aName. More...

SYMBOL_LIB *	FindLibraryByFullFileName (const wxString &aFullFileName)

SYMBOL_LIB *	GetCacheLibrary ()

wxArrayString	GetLibraryNames (bool aSorted=true)
	Return the list of symbol library file names without path and extension. More...

LIB_SYMBOL *	FindLibSymbol (const LIB_ID &aLibId, const wxString &aLibraryName=wxEmptyString)
	Search all libraries in the list for a symbol. More...

void	FindLibraryNearEntries (std::vector< LIB_SYMBOL * > &aCandidates, const wxString &aEntryName, const wxString &aLibraryName=wxEmptyString)
	Search all libraries in the list for a LIB_SYMBOL using a case insensitive comparison. More...

int	GetLibraryCount ()

Static Public Member Functions
static void	GetLibNamesAndPaths (PROJECT aProject, wxString aPaths, wxArrayString *aNames=nullptr)

static void	SetLibNamesAndPaths (PROJECT *aProject, const wxString &aPaths, const wxArrayString &aNames)

static const wxString	CacheName (const wxString &aFullProjectFilename)
	Return the name of the cache library after potentially fixing it from an older naming scheme. More...

Detailed Description

A collection of SYMBOL_LIB objects.

It extends from PROJECT::_ELEM so it can be hung in the PROJECT. It does not use any UI calls, but rather simply throws an IO_ERROR when there is a problem.

Definition at line 62 of file symbol_library.h.

Constructor & Destructor Documentation

◆ SYMBOL_LIBS()

SYMBOL_LIBS::SYMBOL_LIBS ( )

inline

Definition at line 67 of file symbol_library.h.

Member Function Documentation

◆ AddLibrary() [1/2]

SYMBOL_LIB * SYMBOL_LIBS::AddLibrary ( const wxString & aFileName )

Allocate and adds a symbol library to the library list.

Parameters

aFileName is the file name object of symbol library.

Exceptions

IO_ERROR if there's any problem loading.

Definition at line 261 of file symbol_library.cpp.

References FindLibrary(), and SYMBOL_LIB::LoadSymbolLibrary().

Referenced by LoadAllLibraries().

◆ AddLibrary() [2/2]

SYMBOL_LIB * SYMBOL_LIBS::AddLibrary	(	const wxString &	aFileName,
		SYMBOL_LIBS::iterator &	aIterator
	)

Insert a symbol library into the library list.

Parameters

aFileName	is the file name object of symbol library.
aIterator	is an iterator to insert library in front of.

Returns: the new SYMBOL_LIB, which remains owned by this SYMBOL_LIBS container.

Exceptions

IO_ERROR if there's any problem loading.

Definition at line 286 of file symbol_library.cpp.

References FindLibrary(), and SYMBOL_LIB::LoadSymbolLibrary().

◆ CacheName()

const wxString SYMBOL_LIBS::CacheName ( const wxString & aFullProjectFilename )

static

Return the name of the cache library after potentially fixing it from an older naming scheme.

That is, the old file is renamed if needed.

Parameters

aFullProjectFilename is the *.pro filename with absolute path.

Definition at line 486 of file symbol_library.cpp.

References LegacySymbolLibFileExtension, and name.

Referenced by LoadAllLibraries().

◆ FindLibrary()

SYMBOL_LIB * SYMBOL_LIBS::FindLibrary ( const wxString & aName )

Find a symbol library by aName.

Parameters

aName is the library file name without path or extension to find.

Returns: the symbol library if found, otherwise NULL.

Definition at line 356 of file symbol_library.cpp.

Referenced by AddLibrary(), LEGACY_RESCUER::OpenRescueLibrary(), and ReloadLibrary().

◆ FindLibraryByFullFileName()

SYMBOL_LIB * SYMBOL_LIBS::FindLibraryByFullFileName ( const wxString & aFullFileName )

Definition at line 380 of file symbol_library.cpp.

◆ FindLibraryNearEntries()

void SYMBOL_LIBS::FindLibraryNearEntries	(	std::vector< LIB_SYMBOL * > &	aCandidates,
		const wxString &	aEntryName,
		const wxString &	aLibraryName = `wxEmptyString`
	)

Search all libraries in the list for a LIB_SYMBOL using a case insensitive comparison.

Helper function used in dialog to find all candidates. During a long time, eeschema was using a case insensitive search. Therefore, for old schematics (<= 2013), or libs, for some symbols, the chip name (name of alias in lib) can be broken. This function can be used to display a list of candidates, in symbol properties dialog.

Parameters

aEntryName	is the name of entries to search for (case insensitive).
aLibraryName	is the name of the library to search.
aCandidates	is a std::vector to store candidates.

Definition at line 435 of file symbol_library.cpp.

References SYMBOL_LIB::FindSymbol(), SYMBOL_LIB::GetName(), and SYMBOL_LIB::GetSymbolNames().

Referenced by RESCUE_CASE_CANDIDATE::FindRescues().