Symbol library management helper that is specific to the symbol library editor frame. More...

#include <lib_symbol_library_manager.h>

Inheritance diagram for LIB_SYMBOL_LIBRARY_MANAGER:

Public Member Functions
	LIB_SYMBOL_LIBRARY_MANAGER (SYMBOL_EDIT_FRAME &aFrame)

void	Sync (const wxString &aForceRefresh, std::function< void(int, int, const wxString &)> aProgressCallback)
	Updates the SYMBOL_LIBRARY_MANAGER data to synchronize with Symbol Library Table.

wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > &	GetAdapter ()
	Return the adapter object that provides the stored data.

void	Preload (PROGRESS_REPORTER &aReporter)
	Preload all symbol libraries in the symbol library table using SYMBOL_ASYNC_LOADER.

int	GetHash () const

bool	HasModifications () const

int	GetLibraryHash (const wxString &aLibrary) const
	Return a library hash value to determine if it has changed.

wxArrayString	GetLibraryNames () const
	Return the array of library names.

SYMBOL_LIB_TABLE_ROW *	GetLibrary (const wxString &aLibrary) const
	Find a single library within the (aggregate) library table.

std::list< LIB_SYMBOL * >	EnumerateSymbols (const wxString &aLibrary) const

bool	CreateLibrary (const wxString &aFilePath, SYMBOL_LIB_TABLE &aTable)
	Create an empty library and adds it to the library table.

bool	AddLibrary (const wxString &aFilePath, SYMBOL_LIB_TABLE &aTable)
	Add an existing library.

bool	UpdateSymbol (LIB_SYMBOL *aSymbol, const wxString &aLibrary)
	Update the symbol buffer with a new version of the symbol.

bool	UpdateSymbolAfterRename (LIB_SYMBOL *aSymbol, const wxString &aOldSymbolName, const wxString &aLibrary)
	Update the symbol buffer with a new version of the symbol when the name has changed.

bool	UpdateLibraryBuffer (const wxString &aLibrary)
	Update the library buffer with a new version of the library.

bool	RemoveSymbol (const wxString &aSymbolName, const wxString &aLibrary)
	Remove the symbol from the symbol buffer.

LIB_SYMBOL *	GetSymbol (const wxString &aSymbolName, const wxString &aLibrary) const
	Return either an alias of a working LIB_SYMBOL copy, or alias of the original symbol if there is no working copy.

LIB_SYMBOL *	GetBufferedSymbol (const wxString &aSymbolName, const wxString &aLibrary)
	Return the symbol copy from the buffer.

SCH_SCREEN *	GetScreen (const wxString &aSymbolName, const wxString &aLibrary)
	Return the screen used to edit a specific symbol.

bool	SymbolExists (const wxString &aSymbolName, const wxString &aLibrary) const
	Return true if symbol with a specific alias exists in library (either original one or buffered).

bool	SymbolNameInUse (const wxString &aName, const wxString &aLibrary)
	Return true if the symbol name is already in use in the specified library.

bool	LibraryExists (const wxString &aLibrary, bool aCheckEnabled=false) const
	Return true if library exists.

bool	IsLibraryLoaded (const wxString &aLibrary) const
	Return true if the library was successfully loaded.

bool	IsLibraryModified (const wxString &aLibrary) const
	Return true if library has unsaved modifications.

bool	IsSymbolModified (const wxString &aSymbolName, const wxString &aLibrary) const
	Return true if symbol has unsaved modifications.

void	SetSymbolModified (const wxString &aSymbolName, const wxString &aLibrary)

bool	ClearLibraryModified (const wxString &aLibrary) const
	Clear the modified flag for all symbols in a library.

bool	ClearSymbolModified (const wxString &aSymbolName, const wxString &aLibrary) const
	Clear the modified flag for a symbol.

bool	IsLibraryReadOnly (const wxString &aLibrary) const
	Return true if the library is stored in a read-only file.

bool	SaveLibrary (const wxString &aLibrary, const wxString &aFileName, SCH_IO_MGR::SCH_FILE_T aFileType=SCH_IO_MGR::SCH_FILE_T::SCH_LEGACY)
	Save library to a file, including unsaved changes.

LIB_ID	RevertSymbol (const wxString &aSymbolName, const wxString &aLibrary)
	Revert unsaved changes for a symbol.

bool	RevertLibrary (const wxString &aLibrary)
	Revert unsaved changes for a symbol library.

bool	RevertAll ()
	Revert all pending changes.

wxString	GetUniqueLibraryName () const
	Return a library name that is not currently in use.

void	GetSymbolNames (const wxString &aLibName, wxArrayString &aSymbolNames, SYMBOL_NAME_FILTER aFilter=SYMBOL_NAME_FILTER::ALL)

bool	HasDerivedSymbols (const wxString &aSymbolName, const wxString &aLibraryName)
	Check if symbol aSymbolName in library aLibraryName is a root symbol that has derived symbols.

size_t	GetLibraryCount () const

Protected Member Functions
void	OnDataChanged () const override

bool	addLibrary (const wxString &aFilePath, bool aCreate, SYMBOL_LIB_TABLE &aTable)
	Helper function to add either existing or create new library.

SYMBOL_LIB_TABLE *	symTable () const
	Return the current symbol library table.

std::set< LIB_SYMBOL * >	getOriginalSymbols (const wxString &aLibrary)
	Return a set of LIB_SYMBOL objects belonging to the original library.

LIB_BUFFER &	getLibraryBuffer (const wxString &aLibrary)
	Return an existing library buffer or creates one to using symbol library table to get the original data.

Static Protected Member Functions
static wxString	getLibraryName (const wxString &aFilePath)
	Extract library name basing on the file name.

Protected Attributes
std::map< wxString, LIB_BUFFER >	m_libs
	The library buffers.

SCH_BASE_FRAME &	m_frame
	Parent frame.

LIB_LOGGER *	m_logger

Private Member Functions
SYMBOL_TREE_SYNCHRONIZING_ADAPTER *	getAdapter ()

Private Attributes
wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER >	m_adapter

int	m_syncHash
	Symbol lib table hash value from last synchronization.

Detailed Description

Symbol library management helper that is specific to the symbol library editor frame.

The base class handles library manipulation; this one also handles synchronizing the LIB_TREE.

Definition at line 32 of file lib_symbol_library_manager.h.

Constructor & Destructor Documentation

◆ LIB_SYMBOL_LIBRARY_MANAGER()

LIB_SYMBOL_LIBRARY_MANAGER::LIB_SYMBOL_LIBRARY_MANAGER ( SYMBOL_EDIT_FRAME & aFrame )

Definition at line 26 of file lib_symbol_library_manager.cpp.

References SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Create(), and m_adapter.

Member Function Documentation

◆ addLibrary()

bool SYMBOL_LIBRARY_MANAGER::addLibrary	(	const wxString &	aFilePath,
		bool	aCreate,
		SYMBOL_LIB_TABLE &	aTable
	)

protectedinherited

Helper function to add either existing or create new library.

Definition at line 760 of file symbol_library_manager.cpp.

References SYMBOL_LIB_TABLE::CreateSymbolLib(), SYMBOL_LIBRARY_MANAGER::getLibraryName(), SCH_IO_MGR::GuessPluginTypeFromLibPath(), LIB_TABLE::InsertRow(), KICTL_CREATE, SYMBOL_LIBRARY_MANAGER::LibraryExists(), SYMBOL_LIBRARY_MANAGER::m_frame, NormalizePath(), SYMBOL_LIBRARY_MANAGER::OnDataChanged(), Pgm(), KIWAY_HOLDER::Prj(), LIB_TABLE::RemoveRow(), and SCH_IO_MGR::ShowType().

Referenced by SYMBOL_LIBRARY_MANAGER::AddLibrary(), and SYMBOL_LIBRARY_MANAGER::CreateLibrary().

◆ AddLibrary()

bool SYMBOL_LIBRARY_MANAGER::AddLibrary	(	const wxString &	aFilePath,
		SYMBOL_LIB_TABLE &	aTable
	)

inlineinherited

Add an existing library.

The library is added to the library table as well.

Definition at line 236 of file symbol_library_manager.h.

References SYMBOL_LIBRARY_MANAGER::addLibrary().

Referenced by SYMBOL_EDIT_FRAME::AddLibraryFile(), and SYMBOL_EDIT_FRAME::DdAddLibrary().

◆ ClearLibraryModified()

bool SYMBOL_LIBRARY_MANAGER::ClearLibraryModified ( const wxString & aLibrary ) const

inherited

Clear the modified flag for all symbols in a library.

Definition at line 319 of file symbol_library_manager.cpp.

References SYMBOL_LIBRARY_MANAGER::m_libs, and BASE_SCREEN::SetContentModified().

Referenced by SYMBOL_EDIT_FRAME::saveLibrary().

◆ ClearSymbolModified()

bool SYMBOL_LIBRARY_MANAGER::ClearSymbolModified	(	const wxString &	aSymbolName,
		const wxString &	aLibrary
	)		const

inherited

Clear the modified flag for a symbol.

Definition at line 338 of file symbol_library_manager.cpp.

References SYMBOL_LIBRARY_MANAGER::m_libs.

Referenced by SYMBOL_EDIT_FRAME::Revert().

◆ CreateLibrary()

bool SYMBOL_LIBRARY_MANAGER::CreateLibrary	(	const wxString &	aFilePath,
		SYMBOL_LIB_TABLE &	aTable
	)

inlineinherited

Create an empty library and adds it to the library table.

The library file is created.

Definition at line 226 of file symbol_library_manager.h.

References SYMBOL_LIBRARY_MANAGER::addLibrary().

Referenced by SYMBOL_EDIT_FRAME::AddLibraryFile(), and SCH_BASE_FRAME::SelectLibrary().

◆ EnumerateSymbols()

std::list< LIB_SYMBOL * > SYMBOL_LIBRARY_MANAGER::EnumerateSymbols ( const wxString & aLibrary ) const

inherited

Definition at line 372 of file symbol_library_manager.cpp.

References SYMBOL_LIBRARY_MANAGER::LibraryExists(), SYMBOL_LIB_TABLE::LoadSymbolLib(), SYMBOL_LIBRARY_MANAGER::m_libs, IO_ERROR::Problem(), and SYMBOL_LIBRARY_MANAGER::symTable().

Referenced by SYMBOL_TREE_SYNCHRONIZING_ADAPTER::updateLibrary().

◆ GetAdapter()

wxObjectDataPtr< LIB_TREE_MODEL_ADAPTER > & LIB_SYMBOL_LIBRARY_MANAGER::GetAdapter ( )

inline

Return the adapter object that provides the stored data.

Definition at line 46 of file lib_symbol_library_manager.h.

References m_adapter.

Referenced by SYMBOL_EDIT_FRAME::canCloseWindow(), SYMBOL_EDIT_FRAME::FreezeLibraryTree(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), SYMBOL_TREE_PANE::SYMBOL_TREE_PANE(), SYMBOL_EDIT_FRAME::SyncLibraries(), and SYMBOL_EDIT_FRAME::ThawLibraryTree().

◆ getAdapter()

SYMBOL_TREE_SYNCHRONIZING_ADAPTER * LIB_SYMBOL_LIBRARY_MANAGER::getAdapter ( )

inlineprivate

Definition at line 52 of file lib_symbol_library_manager.h.

References m_adapter.

Referenced by Sync().

◆ GetBufferedSymbol()

LIB_SYMBOL * SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol	(	const wxString &	aSymbolName,
		const wxString &	aLibrary
	)

inherited

Return the symbol copy from the buffer.

In case it does not exist yet, the copy is created. SYMBOL_LIBRARY_MANAGER retains the ownership.

Definition at line 405 of file symbol_library_manager.cpp.

References _, LIB_BUFFER::CreateBuffer(), DisplayErrorMessage(), SYMBOL_LIBRARY_MANAGER::getLibraryBuffer(), LIB_SYMBOL::GetName(), LIB_SYMBOL::GetParent(), LIB_BUFFER::GetSymbol(), LIB_SYMBOL::IsDerived(), SYMBOL_LIBRARY_MANAGER::LibraryExists(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIBRARY_MANAGER::m_frame, LIB_SYMBOL::SetParent(), SYMBOL_LIBRARY_MANAGER::symTable(), THROW_IO_ERROR, and IO_ERROR::What().

Referenced by SYMBOL_EDIT_FRAME::CopySymbolToClipboard(), SYMBOL_EDIT_FRAME::DuplicateSymbol(), SYMBOL_EDIT_FRAME::IsCurrentSymbol(), SYMBOL_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbol(), and SYMBOL_EDITOR_CONTROL::RenameSymbol().

◆ GetHash()

int SYMBOL_LIBRARY_MANAGER::GetHash ( ) const

inherited

Definition at line 107 of file symbol_library_manager.cpp.

References SYMBOL_LIB_TABLE::GetModifyHash(), SYMBOL_LIBRARY_MANAGER::m_libs, name, and SYMBOL_LIBRARY_MANAGER::symTable().

Referenced by SYMBOL_LIBRARY_MANAGER::RevertAll(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ GetLibrary()

SYMBOL_LIB_TABLE_ROW * SYMBOL_LIBRARY_MANAGER::GetLibrary ( const wxString & aLibrary ) const

inherited

Find a single library within the (aggregate) library table.

Definition at line 152 of file symbol_library_manager.cpp.

References _, DisplayErrorMessage(), SYMBOL_LIB_TABLE::FindRow(), SYMBOL_LIBRARY_MANAGER::m_frame, SYMBOL_LIBRARY_MANAGER::symTable(), and IO_ERROR::What().

Referenced by SYMBOL_EDIT_FRAME::ExportSymbol(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SYMBOL_LIBRARY_MANAGER::GetLibraryHash(), SYMBOL_LIBRARY_MANAGER::GetLibraryNames(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), SYMBOL_EDIT_FRAME::IsSymbolFromLegacyLibrary(), SYMBOL_EDIT_FRAME::LoadSymbol(), SYMBOL_EDITOR_CONTROL::OpenDirectory(), SYMBOL_EDITOR_CONTROL::OpenWithTextEditor(), SYMBOL_LIBRARY_MANAGER::SaveLibrary(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ getLibraryBuffer()

LIB_BUFFER & SYMBOL_LIBRARY_MANAGER::getLibraryBuffer ( const wxString & aLibrary )

protectedinherited

Return an existing library buffer or creates one to using symbol library table to get the original data.

Definition at line 831 of file symbol_library_manager.cpp.

References LIB_BUFFER::CreateBuffer(), SYMBOL_LIBRARY_MANAGER::getOriginalSymbols(), LIB_BUFFER::GetSymbol(), and SYMBOL_LIBRARY_MANAGER::m_libs.

Referenced by SYMBOL_LIBRARY_MANAGER::GetBufferedSymbol(), SYMBOL_LIBRARY_MANAGER::GetSymbolNames(), SYMBOL_LIBRARY_MANAGER::HasDerivedSymbols(), SYMBOL_LIBRARY_MANAGER::RemoveSymbol(), SYMBOL_LIBRARY_MANAGER::UpdateLibraryBuffer(), SYMBOL_LIBRARY_MANAGER::UpdateSymbol(), and SYMBOL_LIBRARY_MANAGER::UpdateSymbolAfterRename().

◆ GetLibraryCount()

size_t SYMBOL_LIBRARY_MANAGER::GetLibraryCount ( ) const

inherited

Definition at line 747 of file symbol_library_manager.cpp.

References LIB_TABLE::GetLogicalLibs(), and SYMBOL_LIBRARY_MANAGER::symTable().

◆ GetLibraryHash()

int SYMBOL_LIBRARY_MANAGER::GetLibraryHash ( const wxString & aLibrary ) const

inherited

Return a library hash value to determine if it has changed.

For buffered libraries, it returns a number corresponding to the number of modifications. For original libraries, hash is computed basing on the library URI. Returns -1 when the requested library does not exist.

Definition at line 118 of file symbol_library_manager.cpp.

References LIB_TABLE_ROW::GetFullURI(), SYMBOL_LIBRARY_MANAGER::GetLibrary(), and SYMBOL_LIBRARY_MANAGER::m_libs.

Referenced by SYMBOL_TREE_SYNCHRONIZING_ADAPTER::updateLibrary().

◆ getLibraryName()

wxString SYMBOL_LIBRARY_MANAGER::getLibraryName ( const wxString & aFilePath )

staticprotectedinherited

Extract library name basing on the file name.

Definition at line 753 of file symbol_library_manager.cpp.

Referenced by SYMBOL_LIBRARY_MANAGER::addLibrary().

◆ GetLibraryNames()

wxArrayString SYMBOL_LIBRARY_MANAGER::GetLibraryNames ( ) const

inherited

Return the array of library names.

Definition at line 133 of file symbol_library_manager.cpp.

References SYMBOL_LIBRARY_MANAGER::GetLibrary(), res, SYMBOL_LIB_TABLE_ROW::SchLibType(), and SYMBOL_LIBRARY_MANAGER::symTable().

Referenced by SYMBOL_EDIT_FRAME::ExportSymbol(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetLibrariesCount(), SYMBOL_EDIT_FRAME::IsContentModified(), SYMBOL_EDIT_FRAME::saveAllLibraries(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync().

◆ getOriginalSymbols()

std::set< LIB_SYMBOL * > SYMBOL_LIBRARY_MANAGER::getOriginalSymbols ( const wxString & aLibrary )

protectedinherited

Return a set of LIB_SYMBOL objects belonging to the original library.

Definition at line 806 of file symbol_library_manager.cpp.

References _, SYMBOL_LIB_TABLE::EnumerateSymbolLib(), SYMBOL_LIBRARY_MANAGER::LibraryExists(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIBRARY_MANAGER::symTable(), and IO_ERROR::What().

Referenced by SYMBOL_LIBRARY_MANAGER::getLibraryBuffer(), and SYMBOL_LIBRARY_MANAGER::SaveLibrary().

◆ GetScreen()

SCH_SCREEN * SYMBOL_LIBRARY_MANAGER::GetScreen	(	const wxString &	aSymbolName,
		const wxString &	aLibrary
	)

inherited

Return the screen used to edit a specific symbol.

SYMBOL_LIBRARY_MANAGER retains the ownership.

Definition at line 470 of file symbol_library_manager.cpp.

References LIB_BUFFER::GetBuffer(), SYMBOL_LIBRARY_MANAGER::LibraryExists(), and SYMBOL_LIBRARY_MANAGER::m_libs.

Referenced by SYMBOL_EDIT_FRAME::KiwayMailIn(), and SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux().

◆ GetSymbol()

LIB_SYMBOL * SYMBOL_LIBRARY_MANAGER::GetSymbol	(	const wxString &	aSymbolName,
		const wxString &	aLibrary
	)		const

inherited

Return either an alias of a working LIB_SYMBOL copy, or alias of the original symbol if there is no working copy.

Definition at line 620 of file symbol_library_manager.cpp.

References _, DisplayErrorMessage(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIBRARY_MANAGER::m_frame, SYMBOL_LIBRARY_MANAGER::m_libs, SYMBOL_LIBRARY_MANAGER::symTable(), and IO_ERROR::What().

Referenced by CheckSavingIntoOwnInheritance(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SYMBOL_SAVE_AS_HANDLER::DoSave(), SYMBOL_EDIT_FRAME::getTargetSymbol(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetSymbolNames()

void SYMBOL_LIBRARY_MANAGER::GetSymbolNames	(	const wxString &	aLibName,
		wxArrayString &	aSymbolNames,
		SYMBOL_NAME_FILTER	aFilter = `SYMBOL_NAME_FILTER::ALL`
	)

inherited

Definition at line 728 of file symbol_library_manager.cpp.

References SYMBOL_LIBRARY_MANAGER::getLibraryBuffer(), and LIB_BUFFER::GetSymbolNames().

Referenced by SYMBOL_EDIT_FRAME::CreateNewSymbol(), SYMBOL_LIBRARY_MANAGER::SymbolNameInUse(), and DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ GetUniqueLibraryName()

wxString SYMBOL_LIBRARY_MANAGER::GetUniqueLibraryName ( ) const

inherited

Return a library name that is not currently in use.

Used for generating names for new libraries.

Definition at line 708 of file symbol_library_manager.cpp.

References SYMBOL_LIBRARY_MANAGER::LibraryExists(), and name.

Referenced by SYMBOL_EDIT_FRAME::AddLibraryFile().

◆ HasDerivedSymbols()

bool SYMBOL_LIBRARY_MANAGER::HasDerivedSymbols	(	const wxString &	aSymbolName,
		const wxString &	aLibraryName
	)

inherited

Check if symbol aSymbolName in library aLibraryName is a root symbol that has derived symbols.

Returns: true if \aSymbolName in aLibraryName has derived symbols.

Definition at line 738 of file symbol_library_manager.cpp.

References SYMBOL_LIBRARY_MANAGER::getLibraryBuffer(), and LIB_BUFFER::HasDerivedSymbols().

Referenced by SYMBOL_EDIT_FRAME::DeleteSymbolFromLibrary().

◆ HasModifications()

bool SYMBOL_LIBRARY_MANAGER::HasModifications ( ) const

inherited

Definition at line 95 of file symbol_library_manager.cpp.

References SYMBOL_LIBRARY_MANAGER::m_libs, and name.

Referenced by SYMBOL_EDIT_FRAME::HasLibModifications().

◆ IsLibraryLoaded()

bool SYMBOL_LIBRARY_MANAGER::IsLibraryLoaded ( const wxString & aLibrary ) const

inherited

Return true if the library was successfully loaded.

Definition at line 363 of file symbol_library_manager.cpp.

References SYMBOL_LIB_TABLE::IsSymbolLibLoaded(), SYMBOL_LIBRARY_MANAGER::LibraryExists(), and SYMBOL_LIBRARY_MANAGER::symTable().

Referenced by SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), and SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue().

◆ IsLibraryModified()

bool SYMBOL_LIBRARY_MANAGER::IsLibraryModified ( const wxString & aLibrary ) const

inherited

Return true if library has unsaved modifications.

Definition at line 280 of file symbol_library_manager.cpp.

References SYMBOL_LIBRARY_MANAGER::m_libs.

Referenced by SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDIT_FRAME::IsContentModified(), and SYMBOL_EDIT_FRAME::saveAllLibraries().

◆ IsLibraryReadOnly()

bool SYMBOL_LIBRARY_MANAGER::IsLibraryReadOnly ( const wxString & aLibrary ) const

inherited

Return true if the library is stored in a read-only file.

Returns: True on success, false otherwise.

Definition at line 354 of file symbol_library_manager.cpp.

References SYMBOL_LIB_TABLE::IsSymbolLibWritable(), SYMBOL_LIBRARY_MANAGER::LibraryExists(), and SYMBOL_LIBRARY_MANAGER::symTable().

◆ IsSymbolModified()

bool SYMBOL_LIBRARY_MANAGER::IsSymbolModified	(	const wxString &	aSymbolName,
		const wxString &	aLibrary
	)		const

inherited

Return true if symbol has unsaved modifications.

Definition at line 287 of file symbol_library_manager.cpp.

References LIB_BUFFER::GetBuffer(), and SYMBOL_LIBRARY_MANAGER::m_libs.

Referenced by SYMBOL_EDIT_FRAME::DeleteSymbolFromLibrary(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetValue(), and SYMBOL_EDIT_FRAME::setupUIConditions().

◆ LibraryExists()

bool SYMBOL_LIBRARY_MANAGER::LibraryExists	(	const wxString &	aLibrary,
		bool	aCheckEnabled = `false`
	)		const

inherited

Return true if library exists.

If aCheckEnabled is set, then the library must also be enabled in the library table.

Definition at line 696 of file symbol_library_manager.cpp.

References LIB_TABLE::HasLibrary(), SYMBOL_LIBRARY_MANAGER::m_libs, and SYMBOL_LIBRARY_MANAGER::symTable().

◆ OnDataChanged()

void LIB_SYMBOL_LIBRARY_MANAGER::OnDataChanged ( ) const

overrideprotectedvirtual

Reimplemented from SYMBOL_LIBRARY_MANAGER.

Definition at line 48 of file lib_symbol_library_manager.cpp.

References SYMBOL_LIBRARY_MANAGER::m_frame.

◆ Preload()

void SYMBOL_LIBRARY_MANAGER::Preload ( PROGRESS_REPORTER & aReporter )

inherited

Preload all symbol libraries in the symbol library table using SYMBOL_ASYNC_LOADER.

Call before the first call to Sync() to get better performance.

Parameters

aReporter is used to report progress of the load

Definition at line 61 of file symbol_library_manager.cpp.

References _, HTML_MESSAGE_BOX::AddHTML_Text(), SYMBOL_ASYNC_LOADER::Done(), SYMBOL_ASYNC_LOADER::GetErrors(), SYMBOL_ASYNC_LOADER::Join(), PROGRESS_REPORTER::KeepRefreshing(), SYMBOL_LIBRARY_MANAGER::m_frame, HTML_MESSAGE_BOX::MessageSet(), DIALOG_SHIM::ShowModal(), SYMBOL_ASYNC_LOADER::Start(), and SYMBOL_LIBRARY_MANAGER::symTable().

◆ RemoveSymbol()

bool SYMBOL_LIBRARY_MANAGER::RemoveSymbol	(	const wxString &	aSymbolName,
		const wxString &	aLibrary
	)

inherited

Remove the symbol from the symbol buffer.

It is required to save the library to have the symbol removed in the schematic editor.

Definition at line 605 of file symbol_library_manager.cpp.

References LIB_BUFFER::DeleteBuffer(), LIB_BUFFER::GetBuffer(), SYMBOL_LIBRARY_MANAGER::getLibraryBuffer(), and SYMBOL_LIBRARY_MANAGER::OnDataChanged().

Referenced by SYMBOL_EDIT_FRAME::DeleteSymbolFromLibrary(), and SYMBOL_EDITOR_CONTROL::RenameSymbol().

◆ RevertAll()

bool SYMBOL_LIBRARY_MANAGER::RevertAll ( )

inherited

Revert all pending changes.

Returns: True if all changes successfully reverted.

Definition at line 579 of file symbol_library_manager.cpp.

References SYMBOL_LIBRARY_MANAGER::GetHash(), SYMBOL_LIBRARY_MANAGER::m_libs, and SYMBOL_LIBRARY_MANAGER::RevertSymbol().

Referenced by SYMBOL_EDIT_FRAME::RevertAll().

◆ RevertLibrary()

bool SYMBOL_LIBRARY_MANAGER::RevertLibrary ( const wxString & aLibrary )

inherited

Revert unsaved changes for a symbol library.

Returns: True on success, false otherwise.

Definition at line 565 of file symbol_library_manager.cpp.

References SYMBOL_LIBRARY_MANAGER::m_libs, and SYMBOL_LIBRARY_MANAGER::OnDataChanged().

Referenced by SYMBOL_EDIT_FRAME::Revert().

◆ RevertSymbol()

LIB_ID SYMBOL_LIBRARY_MANAGER::RevertSymbol	(	const wxString &	aSymbolName,
		const wxString &	aLibrary
	)

inherited

Revert unsaved changes for a symbol.

Returns: The LIB_ID of the reverted symbol (which may be different in the case of a rename)

Definition at line 539 of file symbol_library_manager.cpp.

References LIB_SYMBOL::GetName(), SYMBOL_LIBRARY_MANAGER::m_libs, SYMBOL_LIBRARY_MANAGER::OnDataChanged(), and SYMBOL_LIBRARY_MANAGER::UpdateSymbolAfterRename().

Referenced by SYMBOL_EDIT_FRAME::Revert(), and SYMBOL_LIBRARY_MANAGER::RevertAll().

◆ SaveLibrary()

bool SYMBOL_LIBRARY_MANAGER::SaveLibrary	(	const wxString &	aLibrary,
		const wxString &	aFileName,
		SCH_IO_MGR::SCH_FILE_T	aFileType = `SCH_IO_MGR::SCH_FILE_T::SCH_LEGACY`
	)