Object used to load, save, search, and otherwise manipulate symbol library files. More...

#include <symbol_library.h>

Public Member Functions
	SYMBOL_LIB (SCH_LIB_TYPE aType, const wxString &aFileName, SCH_IO_MGR::SCH_FILE_T aPluginType=SCH_IO_MGR::SCH_LEGACY)

	~SYMBOL_LIB ()

int	GetModHash () const

SCH_IO_MGR::SCH_FILE_T	GetPluginType () const

void	SetPluginType (SCH_IO_MGR::SCH_FILE_T aPluginType)

void	Create (const wxString &aFileName=wxEmptyString)

void	SetFileName (const wxString &aFileName)

bool	IsModified () const

bool	IsCache () const

void	SetCache ()

bool	IsBuffering () const

void	EnableBuffering (bool aEnable=true)

void	Save (bool aSaveDocFile=true)

bool	IsReadOnly () const

void	GetSymbolNames (wxArrayString &aNames) const
	Load a string array with the names of all the entries in this library. More...

void	GetSymbols (std::vector< LIB_SYMBOL * > &aSymbols) const
	Load a vector with all the entries in this library. More...

LIB_SYMBOL *	FindSymbol (const wxString &aName) const
	Find LIB_SYMBOL by aName. More...

LIB_SYMBOL *	FindSymbol (const LIB_ID &aLibId) const

void	AddSymbol (LIB_SYMBOL *aSymbol)
	Add aSymbol entry to library. More...

LIB_SYMBOL *	RemoveSymbol (LIB_SYMBOL *aEntry)
	Safely remove aEntry from the library and return the next entry. More...

LIB_SYMBOL *	ReplaceSymbol (LIB_SYMBOL aOldSymbol, LIB_SYMBOL aNewSymbol)
	Replace an existing symbol entry in the library. More...

const wxString	GetName () const
	Return the file name without path or extension. More...

wxString	GetFullFileName () const
	Return the full file library name with path and extension. More...

const wxString	GetLogicalName () const
	Return the logical name of the library. More...

Static Public Member Functions
static SYMBOL_LIB *	LoadSymbolLibrary (const wxString &aFileName)
	Allocate and load a symbol library file. More...

Private Attributes
SCH_LIB_TYPE	type
	Library type indicator. More...

wxFileName	fileName
	Library file name. More...

wxDateTime	timeStamp
	Library save time and date. More...

int	versionMajor
	Library major version number. More...

int	versionMinor
	Library minor version number. More...

wxString	header
	first line of loaded library. More...

bool	isModified
	Library modification status. More...

int	m_mod_hash
	incremented each time library is changed. More...

SCH_IO_MGR::SCH_FILE_T	m_pluginType

std::unique_ptr< SCH_PLUGIN >	m_plugin

std::unique_ptr< STRING_UTF8_MAP >	m_properties
	Library properties. More...

Detailed Description

Object used to load, save, search, and otherwise manipulate symbol library files.

Warning: This code is obsolete with the exception of the cache library. All other symbol library I/O is managed by the SCH_IO_MGR object.

Definition at line 168 of file symbol_library.h.

Constructor & Destructor Documentation

◆ SYMBOL_LIB()

SYMBOL_LIB::SYMBOL_LIB	(	SCH_LIB_TYPE	aType,
		const wxString &	aFileName,
		SCH_IO_MGR::SCH_FILE_T	aPluginType = `SCH_IO_MGR::SCH_LEGACY`
	)

Definition at line 49 of file symbol_library.cpp.

 :
 m_pluginType( aPluginType )
{
 type = aType;
 isModified = false;
 timeStamp = 0;
 timeStamp = wxDateTime::Now();
 versionMajor = 0; // Will be updated after reading the lib file
 versionMinor = 0; // Will be updated after reading the lib file
 
 fileName = aFileName;
 
 if( !fileName.IsOk() )
 fileName = "unnamed.lib";
 
 m_plugin.reset( SCH_IO_MGR::FindPlugin( m_pluginType ) );
 m_properties = std::make_unique<STRING_UTF8_MAP>();
 m_mod_hash = 0;
}

References fileName, isModified, m_mod_hash, m_plugin, m_pluginType, m_properties, timeStamp, type, versionMajor, and versionMinor.

◆ ~SYMBOL_LIB()

SYMBOL_LIB::~SYMBOL_LIB ( )

Definition at line 71 of file symbol_library.cpp.

72{

73}

Member Function Documentation

◆ AddSymbol()

void SYMBOL_LIB::AddSymbol ( LIB_SYMBOL * aSymbol )

Add aSymbol entry to library.

Note: A LIB_SYMBOL can have an alias list so these alias will be added in library. and the any existing duplicate aliases will be removed from the library.

Parameters

aSymbol is the symbol to add, caller retains ownership, a clone is added.

Definition at line 185 of file symbol_library.cpp.

{
 // add a clone, not the caller's copy, the plugin take ownership of the new symbol.
 m_plugin->SaveSymbol( fileName.GetFullPath(),
 new LIB_SYMBOL( *aSymbol->SharedPtr().get(), this ),
 m_properties.get() );
 
 // If we are not buffering, the library file is updated immediately when the plugin
 // SaveSymbol() function is called.
 if( IsBuffering() )
 isModified = true;
 
 ++m_mod_hash;
}

References fileName, IsBuffering(), isModified, m_mod_hash, m_plugin, m_properties, and LIB_SYMBOL::SharedPtr().

◆ Create()

void SYMBOL_LIB::Create ( const wxString & aFileName = wxEmptyString )

Definition at line 92 of file symbol_library.cpp.

{
 wxString tmpFileName = fileName.GetFullPath();
 
 if( !aFileName.IsEmpty() )
 tmpFileName = aFileName;
 
 m_plugin->CreateSymbolLib( tmpFileName, m_properties.get() );
}

References fileName, m_plugin, and m_properties.

◆ EnableBuffering()

void SYMBOL_LIB::EnableBuffering ( bool aEnable = true )

Definition at line 131 of file symbol_library.cpp.

{
 if( aEnable )
 (*m_properties)[ SCH_LEGACY_PLUGIN::PropBuffering ] = "";
 else
 m_properties->Clear( SCH_LEGACY_PLUGIN::PropBuffering );
}

References m_properties, and SCH_LEGACY_PLUGIN::PropBuffering.

◆ FindSymbol() [1/2]

LIB_SYMBOL * SYMBOL_LIB::FindSymbol ( const LIB_ID & aLibId ) const

Definition at line 179 of file symbol_library.cpp.

{
 return FindSymbol( aLibId.Format().wx_str() );
}

References FindSymbol(), LIB_ID::Format(), and UTF8::wx_str().

◆ FindSymbol() [2/2]

LIB_SYMBOL * SYMBOL_LIB::FindSymbol ( const wxString & aName ) const

Find LIB_SYMBOL by aName.

Parameters

aName is the name of the symbol, case sensitive.

Returns: LIB_SYMBOL pointer symbol if found, else NULL.

Definition at line 160 of file symbol_library.cpp.

{
 LIB_SYMBOL* symbol = m_plugin->LoadSymbol( fileName.GetFullPath(), aName, m_properties.get() );
 
 if( symbol )
 {
 // Set the library to this even though technically the legacy cache plugin owns the
 // symbols. This allows the symbol library table conversion tool to determine the
 // correct library where the symbol was found.
 if( !symbol->GetLib() )
 symbol->SetLib( const_cast<SYMBOL_LIB*>( this ) );
 
 SIM_MODEL::MigrateSimModel<LIB_SYMBOL, LIB_FIELD>( *symbol, nullptr );
 }
 
 return symbol;
}

References fileName, LIB_SYMBOL::GetLib(), m_plugin, m_properties, and LIB_SYMBOL::SetLib().

Referenced by SYMBOL_LIBS::FindLibraryNearEntries(), SYMBOL_LIBS::FindLibSymbol(), FindSymbol(), SchGetLibSymbol(), and SCH_SCREEN::UpdateSymbolLinks().

◆ GetFullFileName()

wxString SYMBOL_LIB::GetFullFileName ( ) const

inline

Return the full file library name with path and extension.

Returns: the full library file name with path and extension.

Definition at line 278 of file symbol_library.h.

278{ return fileName.GetFullPath(); }

References fileName.

◆ GetLogicalName()

const wxString SYMBOL_LIB::GetLogicalName ( ) const

inline

Return the logical name of the library.

Returns: The logical name of this library.

Definition at line 285 of file symbol_library.h.

 {
 /* for now is the filename without path or extension.
 
 Technically the library should not know its logical name!
 This will eventually come out of a pair of lookup tables using a
 reverse lookup using the full name or library pointer as a key.
 Search will be by project lookup table and then user lookup table if
 not found.
 */
 return fileName.GetName();
 }

References fileName.

◆ GetModHash()

int SYMBOL_LIB::GetModHash ( ) const

inline

Returns: a magic number that changes if the library has changed

Definition at line 178 of file symbol_library.h.

178{ return m_mod_hash; }

References m_mod_hash.

◆ GetName()

const wxString SYMBOL_LIB::GetName ( void ) const

inline

Return the file name without path or extension.

Returns: the name of library file.

Definition at line 271 of file symbol_library.h.

271{ return fileName.GetName(); }

References fileName.

Referenced by SYMBOL_LIBS::FindLibraryNearEntries(), SYMBOL_LIBS::FindLibSymbol(), LIB_SYMBOL::GetLibraryName(), and SYMBOL_LIBS::GetLibraryNames().

◆ GetPluginType()

SCH_IO_MGR::SCH_FILE_T SYMBOL_LIB::GetPluginType ( ) const

inline

Definition at line 180 of file symbol_library.h.

180{ return m_pluginType; }

References m_pluginType.

◆ GetSymbolNames()

void SYMBOL_LIB::GetSymbolNames ( wxArrayString & aNames ) const

Load a string array with the names of all the entries in this library.

Parameters

aNames is the array to place entry names into.

Definition at line 140 of file symbol_library.cpp.

{
 m_plugin->EnumerateSymbolLib( aNames, fileName.GetFullPath(), m_properties.get() );
 
 aNames.Sort();
}

References fileName, m_plugin, and m_properties.

Referenced by SYMBOL_LIBS::FindLibraryNearEntries().

◆ GetSymbols()

void SYMBOL_LIB::GetSymbols ( std::vector< LIB_SYMBOL * > & aSymbols ) const

Load a vector with all the entries in this library.

Parameters

aSymbols is a vector to receive the aliases.

Definition at line 148 of file symbol_library.cpp.

{
 m_plugin->EnumerateSymbolLib( aSymbols, fileName.GetFullPath(), m_properties.get() );
 
 std::sort( aSymbols.begin(), aSymbols.end(),
 [](LIB_SYMBOL *lhs, LIB_SYMBOL *rhs) -> bool
 {
 return lhs->GetName() < rhs->GetName();
 } );
}

References fileName, m_plugin, and m_properties.

Referenced by LEGACY_RESCUER::OpenRescueLibrary().

◆ IsBuffering()

bool SYMBOL_LIB::IsBuffering ( ) const

Definition at line 125 of file symbol_library.cpp.

{
 return m_properties->Exists( SCH_LEGACY_PLUGIN::PropBuffering );
}

References m_properties, and SCH_LEGACY_PLUGIN::PropBuffering.

Referenced by AddSymbol(), RemoveSymbol(), and ReplaceSymbol().

◆ IsCache()

bool SYMBOL_LIB::IsCache ( ) const

Definition at line 113 of file symbol_library.cpp.

{
 return m_properties->Exists( SCH_LEGACY_PLUGIN::PropNoDocFile );
}

References m_properties, and SCH_LEGACY_PLUGIN::PropNoDocFile.

Referenced by SYMBOL_LIBS::GetLibraryNames(), SchGetLibSymbol(), and SCH_SCREEN::UpdateSymbolLinks().

◆ IsModified()

bool SYMBOL_LIB::IsModified ( ) const

inline

Definition at line 188 of file symbol_library.h.

 {
 return isModified;
 }

References isModified.

◆ IsReadOnly()

bool SYMBOL_LIB::IsReadOnly ( ) const

inline

Returns: true if current user does not have write access to the library file.

Definition at line 206 of file symbol_library.h.

206{ return !fileName.IsFileWritable(); }

References fileName.

◆ LoadSymbolLibrary()

SYMBOL_LIB * SYMBOL_LIB::LoadSymbolLibrary ( const wxString & aFileName )

static

Allocate and load a symbol library file.

Parameters

aFileName is the file name of the symbol library to load.

Returns: SYMBOL_LIB* is the allocated and loaded SYMBOL_LIB, which is owned by the caller.

Exceptions

IO_ERROR if there's any problem loading the library.

Definition at line 238 of file symbol_library.cpp.

{
 std::unique_ptr<SYMBOL_LIB> lib = std::make_unique<SYMBOL_LIB>( SCH_LIB_TYPE::LT_EESCHEMA,
 aFileName );
 
 std::vector<LIB_SYMBOL*> parts;
 // This loads the library.
 lib->GetSymbols( parts );
 
 // Now, set the LIB_SYMBOL m_library member but it will only be used
 // when loading legacy libraries in the future. Once the symbols in the
 // schematic have a full #LIB_ID, this will not get called.
 for( size_t ii = 0; ii < parts.size(); ii++ )
 {
 LIB_SYMBOL* part = parts[ii];
 
 part->SetLib( lib.get() );
 }
 
 SYMBOL_LIB* ret = lib.release();
 return ret;
}

References LT_EESCHEMA, and LIB_SYMBOL::SetLib().

Referenced by SYMBOL_LIBS::AddLibrary().

◆ RemoveSymbol()

LIB_SYMBOL * SYMBOL_LIB::RemoveSymbol ( LIB_SYMBOL * aEntry )

Safely remove aEntry from the library and return the next entry.

The next entry returned depends on the entry being removed. If the entry being remove also removes the symbol, then the next entry from the list is returned. If the entry being used only removes an alias from a symbol, then the next alias of the symbol is returned.

Parameters

aEntry is the entry to remove from library.

Returns: The next entry in the library or NULL if the library is empty.

Definition at line 201 of file symbol_library.cpp.

{
 wxCHECK_MSG( aEntry != nullptr, nullptr, "NULL pointer cannot be removed from library." );
 
 m_plugin->DeleteSymbol( fileName.GetFullPath(), aEntry->GetName(), m_properties.get() );
 
 // If we are not buffering, the library file is updated immediately when the plugin
 // SaveSymbol() function is called.
 if( IsBuffering() )
 isModified = true;
 
 ++m_mod_hash;
 return nullptr;
}

References fileName, LIB_SYMBOL::GetName(), IsBuffering(), isModified, m_mod_hash, m_plugin, and m_properties.

◆ ReplaceSymbol()

LIB_SYMBOL * SYMBOL_LIB::ReplaceSymbol	(	LIB_SYMBOL *	aOldSymbol,
		LIB_SYMBOL *	aNewSymbol
	)

Replace an existing symbol entry in the library.

Note: A symbol can have an alias list so these aliases will be added in library and previously existing alias removed.

Parameters

aOldSymbol	is the symbol to replace.
aNewSymbol	is the new symbol.

Definition at line 217 of file symbol_library.cpp.

{
 wxASSERT( aOldSymbol != nullptr );
 wxASSERT( aNewSymbol != nullptr );
 
 m_plugin->DeleteSymbol( fileName.GetFullPath(), aOldSymbol->GetName(), m_properties.get() );
 
 LIB_SYMBOL* my_part = new LIB_SYMBOL( *aNewSymbol, this );
 
 m_plugin->SaveSymbol( fileName.GetFullPath(), my_part, m_properties.get() );
 
 // If we are not buffering, the library file is updated immediately when the plugin
 // SaveSymbol() function is called.
 if( IsBuffering() )
 isModified = true;
 
 ++m_mod_hash;
 return my_part;
}

References fileName, LIB_SYMBOL::GetName(), IsBuffering(), isModified, m_mod_hash, m_plugin, and m_properties.

◆ Save()

void SYMBOL_LIB::Save ( bool aSaveDocFile = true )

Definition at line 76 of file symbol_library.cpp.

{
 wxCHECK_RET( m_plugin != nullptr,
 wxString::Format( wxT( "no plugin defined for library `%s`." ),
 fileName.GetFullPath() ) );
 
 STRING_UTF8_MAP props;
 
 if( !aSaveDocFile )
 props[ SCH_LEGACY_PLUGIN::PropNoDocFile ] = "";
 
 m_plugin->SaveLibrary( fileName.GetFullPath(), &props );
 isModified = false;
}

References fileName, Format(), isModified, m_plugin, and SCH_LEGACY_PLUGIN::PropNoDocFile.

◆ SetCache()

void SYMBOL_LIB::SetCache ( )

Definition at line 119 of file symbol_library.cpp.

{
 (*m_properties)[ SCH_LEGACY_PLUGIN::PropNoDocFile ] = "";
}

References SCH_LEGACY_PLUGIN::PropNoDocFile.

Referenced by SYMBOL_LIBS::LoadAllLibraries().

◆ SetFileName()

void SYMBOL_LIB::SetFileName ( const wxString & aFileName )

inline

Definition at line 186 of file symbol_library.h.

186{ fileName = aFileName; }

References fileName.

◆ SetPluginType()

void SYMBOL_LIB::SetPluginType ( SCH_IO_MGR::SCH_FILE_T aPluginType )

Definition at line 103 of file symbol_library.cpp.

{
 if( m_pluginType != aPluginType )
 {
 m_pluginType = aPluginType;
 m_plugin.reset( SCH_IO_MGR::FindPlugin( m_pluginType ) );
 }
}

References m_plugin, and m_pluginType.

Member Data Documentation

◆ fileName

wxFileName SYMBOL_LIB::fileName

private

Library file name.

Definition at line 309 of file symbol_library.h.

Referenced by AddSymbol(), Create(), FindSymbol(), GetFullFileName(), GetLogicalName(), GetName(), GetSymbolNames(), GetSymbols(), IsReadOnly(), RemoveSymbol(), ReplaceSymbol(), Save(), SetFileName(), and SYMBOL_LIB().

◆ header

wxString SYMBOL_LIB::header

private

first line of loaded library.

Definition at line 313 of file symbol_library.h.

◆ isModified

bool SYMBOL_LIB::isModified

private

Library modification status.

Definition at line 314 of file symbol_library.h.

Referenced by AddSymbol(), IsModified(), RemoveSymbol(), ReplaceSymbol(), Save(), and SYMBOL_LIB().

◆ m_mod_hash

int SYMBOL_LIB::m_mod_hash

private

incremented each time library is changed.

Definition at line 315 of file symbol_library.h.

Referenced by AddSymbol(), GetModHash(), RemoveSymbol(), ReplaceSymbol(), and SYMBOL_LIB().

◆ m_plugin

std::unique_ptr< SCH_PLUGIN > SYMBOL_LIB::m_plugin

private

Definition at line 318 of file symbol_library.h.

Referenced by AddSymbol(), Create(), FindSymbol(), GetSymbolNames(), GetSymbols(), RemoveSymbol(), ReplaceSymbol(), Save(), SetPluginType(), and SYMBOL_LIB().

◆ m_pluginType

SCH_IO_MGR::SCH_FILE_T SYMBOL_LIB::m_pluginType

private

Definition at line 317 of file symbol_library.h.

Referenced by GetPluginType(), SetPluginType(), and SYMBOL_LIB().

◆ m_properties

std::unique_ptr<STRING_UTF8_MAP> SYMBOL_LIB::m_properties

private

Library properties.

Definition at line 319 of file symbol_library.h.

Referenced by AddSymbol(), Create(), EnableBuffering(), FindSymbol(), GetSymbolNames(), GetSymbols(), IsBuffering(), IsCache(), RemoveSymbol(), ReplaceSymbol(), and SYMBOL_LIB().

◆ timeStamp

wxDateTime SYMBOL_LIB::timeStamp

private

Library save time and date.

Definition at line 310 of file symbol_library.h.

Referenced by SYMBOL_LIB().

◆ type

SCH_LIB_TYPE SYMBOL_LIB::type

private

Library type indicator.

Definition at line 308 of file symbol_library.h.

Referenced by SYMBOL_LIB().

◆ versionMajor

int SYMBOL_LIB::versionMajor

private

Library major version number.

Definition at line 311 of file symbol_library.h.

Referenced by SYMBOL_LIB().

◆ versionMinor

int SYMBOL_LIB::versionMinor

private

Library minor version number.

Definition at line 312 of file symbol_library.h.

Referenced by SYMBOL_LIB().

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

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SYMBOL_LIB()

◆ ~SYMBOL_LIB()

Member Function Documentation

◆ AddSymbol()

◆ Create()

◆ EnableBuffering()

◆ FindSymbol() [1/2]

◆ FindSymbol() [2/2]

◆ GetFullFileName()

◆ GetLogicalName()

◆ GetModHash()

◆ GetName()

◆ GetPluginType()

◆ GetSymbolNames()

◆ GetSymbols()

◆ IsBuffering()

◆ IsCache()

◆ IsModified()

◆ IsReadOnly()

◆ LoadSymbolLibrary()

◆ RemoveSymbol()

◆ ReplaceSymbol()

◆ Save()

◆ SetCache()

◆ SetFileName()

◆ SetPluginType()

Member Data Documentation

◆ fileName

◆ header

◆ isModified

◆ m_mod_hash

◆ m_plugin

◆ m_pluginType

◆ m_properties

◆ timeStamp

◆ type

◆ versionMajor

◆ versionMinor