Class PART_LIB is used to load, save, search, and otherwise manipulate part library files. More...

#include <class_library.h>

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

	~PART_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	IsEmpty () const
	Get library entry status. More...

int	GetCount () const
	Function GetCount returns the number of entries in the library. More...

bool	IsModified () const

bool	IsCache () const

void	SetCache ()

bool	IsBuffering () const

void	EnableBuffering (bool aEnable=true)

void	Save (bool aSaveDocFile=true)

bool	IsReadOnly () const
	Function IsReadOnly. More...

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

void	GetAliases (std::vector< LIB_ALIAS * > &aAliases)
	Load a vector with all the entries in this library. More...

void	GetEntryTypePowerNames (wxArrayString &aNames)
	Load a string array with the names of entries of type POWER in this library. More...

LIB_ALIAS *	FindAlias (const wxString &aName)
	Find LIB_ALIAS by aName. More...

LIB_PART *	FindPart (const wxString &aName)
	Find part by aName. More...

void	AddPart (LIB_PART *aPart)
	Add aPart entry to library. More...

LIB_ALIAS *	RemoveAlias (LIB_ALIAS *aEntry)
	Safely remove aEntry from the library and return the next entry. More...

LIB_PART *	ReplacePart (LIB_PART aOldPart, LIB_PART aNewPart)
	Replace an existing part entry in the library. More...

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

wxString	GetFullFileName ()
	Function GetFullFileName returns the full file library name with path and extension. More...

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

bool	HasPowerParts ()
	Function HasPowerParts. More...

Static Public Member Functions
static PART_LIB *	LoadLibrary (const wxString &aFileName)
	Function LoadLibrary allocates and loads a part library file. More...

Private Attributes
int	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< PROPERTIES >	m_properties
	Library properties. More...

Detailed Description

Class PART_LIB is used to load, save, search, and otherwise manipulate part library files.

Definition at line 322 of file class_library.h.

Constructor & Destructor Documentation

PART_LIB::PART_LIB	(	int	aType,
		const wxString &	aFileName,
		SCH_IO_MGR::SCH_FILE_T	aPluginType = `SCH_IO_MGR::SCH_LEGACY`
	)

Definition at line 58 of file class_library.cpp.

References fileName, SCH_IO_MGR::FindPlugin(), isModified, m_plugin, m_pluginType, m_properties, timeStamp, type, versionMajor, and versionMinor.

Referenced by LoadLibrary().

                                                                                            :
     // start @ != 0 so each additional library added
     // is immediately detectable, zero would not be.
     m_mod_hash( PART_LIBS::s_modify_generation ),
     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<PROPERTIES>();
 }

PART_LIB::~PART_LIB ( )

Definition at line 81 of file class_library.cpp.

82 {

83 }

Member Function Documentation

void PART_LIB::AddPart ( LIB_PART * aPart )

Add aPart entry to library.

Note: A LIB_PART 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

aPart - Part to add, caller retains ownership, a clone is added.

Definition at line 235 of file class_library.cpp.

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

Referenced by LIB_EDIT_FRAME::SaveOnePart().

 {
     // add a clone, not the caller's copy, the plugin take ownership of the new symbol.
     m_plugin->SaveSymbol( fileName.GetFullPath(), new LIB_PART( *aPart, 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;
 }

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

Definition at line 101 of file class_library.cpp.

References fileName, m_plugin, and m_properties.

Referenced by LIB_EDIT_FRAME::SaveOnePart().

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

void PART_LIB::EnableBuffering ( bool aEnable = true )

Definition at line 140 of file class_library.cpp.

References m_properties, and SCH_LEGACY_PLUGIN::PropBuffering.

Referenced by LIB_EDIT_FRAME::SaveActiveLibrary().

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

LIB_ALIAS * PART_LIB::FindAlias ( const wxString & aName )

Find LIB_ALIAS by aName.

Parameters

aName - Name of entry, case sensitive.

Returns: LIB_ALIAS* if found. NULL if not found.

Definition at line 189 of file class_library.cpp.

References fileName, LIB_PART::GetLib(), LIB_ALIAS::GetPart(), m_plugin, m_properties, and LIB_PART::SetLib().

Referenced by CMP_TREE_MODEL_ADAPTER::AddAliasList(), DIALOG_EDIT_COMPONENT_IN_LIBRARY::AddAliasOfPart(), LIB_EDIT_FRAME::CreateNewLibraryPart(), LIB_EDIT_FRAME::EditField(), PART_LIBS::FindLibraryAlias(), PART_LIBS::FindLibraryNearEntries(), FindPart(), LIB_VIEW_FRAME::getSelectedAlias(), and LIB_EDIT_FRAME::LoadOneLibraryPart().

 {
     LIB_ALIAS* alias = m_plugin->LoadSymbol( fileName.GetFullPath(), aName, m_properties.get() );
 
     // 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( alias && alias->GetPart() && !alias->GetPart()->GetLib() )
         alias->GetPart()->SetLib( this );
 
     return alias;
 }

LIB_PART * PART_LIB::FindPart ( const wxString & aName )

Find part by aName.

This is a helper for FindEntry so casting a LIB_ALIAS pointer to a LIB_PART pointer is not required.

Parameters

aName - Name of part, case sensitive.

Returns: LIB_PART* - part if found, else NULL.

Definition at line 203 of file class_library.cpp.

References FindAlias(), and LIB_ALIAS::GetPart().

Referenced by LIB_VIEW_FRAME::BestZoom(), PART_LIBS::FindLibPart(), and LIB_EDIT_FRAME::SaveOnePart().

 {
     LIB_ALIAS* alias = FindAlias( aName );
 
     if( alias != NULL )
         return alias->GetPart();
 
     return NULL;
 }

void PART_LIB::GetAliases ( std::vector< LIB_ALIAS * > & aAliases )

Load a vector with all the entries in this library.

Parameters

aAliases - vector to receive the aliases.

Definition at line 157 of file class_library.cpp.

References fileName, LIB_ALIAS::GetName(), m_plugin, and m_properties.

Referenced by CMP_TREE_MODEL_ADAPTER::AddLibrary().

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

void PART_LIB::GetAliasNames ( wxArrayString & aNames )

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

Parameters

aNames - String array to place entry names into.

Definition at line 149 of file class_library.cpp.

References fileName, m_plugin, and m_properties.

Referenced by SCH_BASE_FRAME::DisplayListComponentsInLib(), LIB_EDIT_FRAME::EditField(), PART_LIBS::FindLibraryNearEntries(), and LIB_VIEW_FRAME::ReCreateListCmp().

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

int PART_LIB::GetCount ( ) const

inline

Function GetCount returns the number of entries in the library.

Returns: The number of part and alias entries.

Definition at line 371 of file class_library.h.

Referenced by LIB_EDIT_FRAME::SaveActiveLibrary().

     {
         return (int) m_plugin->GetSymbolLibCount( fileName.GetFullPath() );
     }

void PART_LIB::GetEntryTypePowerNames ( wxArrayString & aNames )

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

Parameters

aNames - String array to place entry names into.

Definition at line 167 of file class_library.cpp.

References fileName, LIB_ALIAS::GetName(), LIB_ALIAS::GetPart(), LIB_PART::IsPower(), m_plugin, and EDA_ITEM::Sort().

Referenced by CMP_TREE_MODEL_ADAPTER::AddLibrary(), and LIB_VIEW_FRAME::ReCreateListCmp().

 {
     std::vector<LIB_ALIAS*> aliases;
 
     m_plugin->EnumerateSymbolLib( aliases, fileName.GetFullPath() );
 
     for( size_t i = 0;  i < aliases.size();  i++ )
     {
         LIB_ALIAS* alias = aliases[i];
 
         LIB_PART* root = alias->GetPart();
 
         if( !root || !root->IsPower() )
             continue;
 
         aNames.Add( alias->GetName() );
     }
 
     aNames.Sort();
 }

wxString PART_LIB::GetFullFileName ( )

inline

Function GetFullFileName returns the full file library name with path and extension.

Returns: wxString - Full library file name with path and extension.

Definition at line 482 of file class_library.h.

Referenced by LIB_VIEW_FRAME::DisplayLibInfos(), LIB_EDIT_FRAME::DisplayLibInfos(), NETLIST_EXPORTER_GENERIC::makeLibraries(), save_library(), LIB_EDIT_FRAME::SaveActiveLibrary(), and LIB_EDIT_FRAME::SaveOnePart().

482 { return fileName.GetFullPath(); }

PART_LIB::fileName

wxFileName fileName

Library file name.

Definition: class_library.h:325

const wxString PART_LIB::GetLogicalName ( )

inline

Function GetLogicalName returns the logical name of the library.

Returns: wxString - The logical name of this library.

Definition at line 489 of file class_library.h.

Referenced by SCH_BASE_FRAME::DisplayListComponentsInLib(), NETLIST_EXPORTER_GENERIC::makeComponents(), NETLIST_EXPORTER_GENERIC::makeLibParts(), and NETLIST_EXPORTER_GENERIC::makeLibraries().

     {
         /*  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();
     }

int PART_LIB::GetModHash ( ) const

inline

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

Definition at line 345 of file class_library.h.

References m_mod_hash.

345 { return m_mod_hash; }

PART_LIB::m_mod_hash

int m_mod_hash

incremented each time library is changed.

Definition: class_library.h:331

const wxString PART_LIB::GetName ( ) const

inline

Return the file name without path or extension.

Returns: Name of library file.

Definition at line 474 of file class_library.h.

474 { return fileName.GetName(); }

PART_LIB::fileName

wxFileName fileName

Library file name.

Definition: class_library.h:325

SCH_IO_MGR::SCH_FILE_T PART_LIB::GetPluginType ( ) const

inline

Definition at line 347 of file class_library.h.

References m_pluginType.

347 { return m_pluginType; }

PART_LIB::m_pluginType

SCH_IO_MGR::SCH_FILE_T m_pluginType

Definition: class_library.h:333

bool PART_LIB::HasPowerParts ( )

Function HasPowerParts.

Returns: true if at least one power part is found in lib Useful to select or list only libs containing power parts

Definition at line 214 of file class_library.cpp.

References fileName, LIB_ALIAS::GetPart(), LIB_PART::IsPower(), m_plugin, and m_properties.

Referenced by LIB_VIEW_FRAME::ReCreateListLib().

 {
     // return true if at least one power part is found in lib
     std::vector<LIB_ALIAS*> aliases;
 
     m_plugin->EnumerateSymbolLib( aliases, fileName.GetFullPath(), m_properties.get() );
 
     for( size_t i = 0;  i < aliases.size();  i++ )
     {
         LIB_ALIAS* alias = aliases[i];
 
         LIB_PART* root = alias->GetPart();
 
         if( !root || root->IsPower() )
             return true;
     }
 
     return false;
 }

bool PART_LIB::IsBuffering ( ) const

Definition at line 134 of file class_library.cpp.

References m_properties, and SCH_LEGACY_PLUGIN::PropBuffering.

Referenced by AddPart(), RemoveAlias(), and ReplacePart().

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

bool PART_LIB::IsCache ( ) const

Definition at line 122 of file class_library.cpp.

References m_properties, and SCH_LEGACY_PLUGIN::PropNoDocFile.

Referenced by PART_LIBS::GetLibraryNames().

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

bool PART_LIB::IsEmpty ( ) const

inline

Get library entry status.

Returns: True if there are no entries in the library.

Definition at line 360 of file class_library.h.

Referenced by LIB_VIEW_FRAME::ReCreateListCmp().

     {
         return m_plugin->GetSymbolLibCount( fileName.GetFullPath() ) == 0;
     }

bool PART_LIB::IsModified ( ) const

inline

Definition at line 376 of file class_library.h.

References isModified.

Referenced by LIB_EDIT_FRAME::OnUpdateSaveCurrentLib().

     {
         return isModified;
     }

bool PART_LIB::IsReadOnly ( ) const

inline

Function IsReadOnly.

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

Definition at line 395 of file class_library.h.

Referenced by LIB_EDIT_FRAME::DisplayLibInfos(), and LIB_EDIT_FRAME::OnUpdateSaveCurrentLib().

395 { return !fileName.IsFileWritable(); }

PART_LIB::fileName

wxFileName fileName

Library file name.

Definition: class_library.h:325

PART_LIB * PART_LIB::LoadLibrary ( const wxString & aFileName )

static

Function LoadLibrary allocates and loads a part library file.

Parameters

aFileName - File name of the part library to load.

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

Exceptions

IO_ERROR if there's any problem loading the library.

Definition at line 286 of file class_library.cpp.

References LIB_ALIAS::GetPart(), LIBRARY_TYPE_EESCHEMA, PART_LIB(), and LIB_PART::SetLib().

Referenced by PART_LIBS::AddLibrary(), and LIB_EDIT_FRAME::OnImportPart().

 {
     std::unique_ptr<PART_LIB> lib( new PART_LIB( LIBRARY_TYPE_EESCHEMA, aFileName ) );
 
     std::vector<LIB_ALIAS*> aliases;
     // This loads the library.
     lib->GetAliases( aliases );
 
     // Now, set the LIB_PART 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 < aliases.size(); ii++ )
     {
         LIB_ALIAS* alias = aliases[ii];
 
         if( alias->GetPart() )
             alias->GetPart()->SetLib( lib.get() );
     }
 
     PART_LIB* ret = lib.release();
     return ret;
 }

LIB_ALIAS * PART_LIB::RemoveAlias ( LIB_ALIAS * 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 part, then the next entry from the list is returned. If the entry being used only removes an alias from a part, then the next alias of the part is returned.

Parameters

aEntry - Entry to remove from library.

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

Definition at line 249 of file class_library.cpp.

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

Referenced by LIB_EDIT_FRAME::DeleteOnePart().

 {
     wxCHECK_MSG( aEntry != NULL, NULL, "NULL pointer cannot be removed from library." );
 
     m_plugin->DeleteAlias( 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 NULL;
 }

LIB_PART * PART_LIB::ReplacePart	(	LIB_PART *	aOldPart,
		LIB_PART *	aNewPart
	)

Replace an existing part entry in the library.

Note a part can have an alias list, so these alias will be added in library (and previously existing alias removed)

Parameters

aOldPart	- The part to replace.
aNewPart	- The new part.

Definition at line 265 of file class_library.cpp.

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

Referenced by LIB_EDIT_FRAME::SaveOnePart().

 {
     wxASSERT( aOldPart != NULL );
     wxASSERT( aNewPart != NULL );
 
     m_plugin->DeleteSymbol( fileName.GetFullPath(), aOldPart->GetName(), m_properties.get() );
 
     LIB_PART* my_part = new LIB_PART( *aNewPart, 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;
 }

void PART_LIB::Save ( bool aSaveDocFile = true )

Definition at line 86 of file class_library.cpp.

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

Referenced by save_library(), and LIB_EDIT_FRAME::SaveActiveLibrary().

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

void PART_LIB::SetCache ( )

Definition at line 128 of file class_library.cpp.

References SCH_LEGACY_PLUGIN::PropNoDocFile.

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

void PART_LIB::SetFileName ( const wxString & aFileName )

inline

Definition at line 353 of file class_library.h.

Referenced by LIB_EDIT_FRAME::SaveActiveLibrary().

353 { fileName = aFileName; }

PART_LIB::fileName

wxFileName fileName

Library file name.

Definition: class_library.h:325

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

Definition at line 112 of file class_library.cpp.

References SCH_IO_MGR::FindPlugin(), m_plugin, and m_pluginType.

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

Member Data Documentation

wxFileName PART_LIB::fileName

private

Library file name.

Definition at line 325 of file class_library.h.

Referenced by AddPart(), Create(), FindAlias(), GetAliases(), GetAliasNames(), GetEntryTypePowerNames(), HasPowerParts(), PART_LIB(), RemoveAlias(), ReplacePart(), and Save().

wxString PART_LIB::header

private

first line of loaded library.

Definition at line 329 of file class_library.h.

bool PART_LIB::isModified

private

Library modification status.

Definition at line 330 of file class_library.h.

Referenced by AddPart(), IsModified(), PART_LIB(), RemoveAlias(), ReplacePart(), and Save().

int PART_LIB::m_mod_hash

private

incremented each time library is changed.

Definition at line 331 of file class_library.h.

Referenced by AddPart(), GetModHash(), RemoveAlias(), and ReplacePart().

std::unique_ptr< SCH_PLUGIN > PART_LIB::m_plugin

private

Definition at line 334 of file class_library.h.

Referenced by AddPart(), Create(), FindAlias(), GetAliases(), GetAliasNames(), GetEntryTypePowerNames(), HasPowerParts(), PART_LIB(), RemoveAlias(), ReplacePart(), Save(), and SetPluginType().

SCH_IO_MGR::SCH_FILE_T PART_LIB::m_pluginType

private

Definition at line 333 of file class_library.h.

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

std::unique_ptr< PROPERTIES > PART_LIB::m_properties

private

Library properties.

Definition at line 335 of file class_library.h.

Referenced by AddPart(), Create(), EnableBuffering(), FindAlias(), GetAliases(), GetAliasNames(), HasPowerParts(), IsBuffering(), IsCache(), PART_LIB(), RemoveAlias(), and ReplacePart().

wxDateTime PART_LIB::timeStamp

private

Library save time and date.

Definition at line 326 of file class_library.h.

Referenced by PART_LIB().

int PART_LIB::type

private

Library type indicator.

Definition at line 324 of file class_library.h.

Referenced by PART_LIB().

int PART_LIB::versionMajor

private

Library major version number.

Definition at line 327 of file class_library.h.

Referenced by PART_LIB().

int PART_LIB::versionMinor

private

Library minor version number.

Definition at line 328 of file class_library.h.

Referenced by PART_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

Member Function Documentation

Member Data Documentation