PART_LIB Class Reference

Object used to load, save, search, and otherwise manipulate symbol 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
	Return 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
void	GetAliasNames (wxArrayString &aNames) const
	Load a string array with the names of all the entries in this library. More...
void	GetAliases (std::vector< LIB_ALIAS *> &aAliases) const
	Load a vector with all the entries in this library. More...
void	GetEntryTypePowerNames (wxArrayString &aNames) const
	Load a string array with the names of entries of type POWER in this library. More...
LIB_ALIAS *	FindAlias (const wxString &aName) const
	Find LIB_ALIAS by aName. More...
LIB_ALIAS *	FindAlias (const LIB_ID &aLibId) const
LIB_PART *	FindPart (const wxString &aName) const
	Find part by aName. More...
LIB_PART *	FindPart (const LIB_ID &aLibId) const
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 () const
	Return the full file library name with path and extension. More...
const wxString	GetLogicalName () const
	Return the logical name of the library. More...
bool	HasPowerParts () const

Static Public Member Functions
static PART_LIB *	LoadLibrary (const wxString &aFileName)
	Allocate and load a symbol 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

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

Definition at line 314 of file class_library.h.

Constructor & Destructor Documentation

PART_LIB()

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, 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::~PART_LIB

(

)

Definition at line 81 of file class_library.cpp.

{
}

Member Function Documentation

AddPart()

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 247 of file class_library.cpp.

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

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

Create()

void PART_LIB::Create

(

const wxString &

aFileName = wxEmptyString

)

Definition at line 101 of file class_library.cpp.

References fileName, m_plugin, and m_properties.

{
    wxString tmpFileName = fileName.GetFullPath();

    if( !aFileName.IsEmpty() )
        tmpFileName = aFileName;

    m_plugin->CreateSymbolLib( tmpFileName, m_properties.get() );
}

EnableBuffering()

void PART_LIB::EnableBuffering

(

bool

aEnable = true

)

Definition at line 140 of file class_library.cpp.

References m_properties, and SCH_LEGACY_PLUGIN::PropBuffering.

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

FindAlias() [1/2]

LIB_ALIAS * PART_LIB::FindAlias

(

const wxString &

aName

)

const

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 FindAlias(), PART_LIBS::FindLibraryAlias(), PART_LIBS::FindLibraryNearEntries(), FindPart(), SCH_COMPONENT::Resolve(), SchGetLibAlias(), and SCH_COMPONENT::SetLibId().

{
    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( const_cast<PART_LIB*>( this ) );

    return alias;
}

FindAlias() [2/2]

LIB_ALIAS * PART_LIB::FindAlias

(

const LIB_ID &

aLibId

)

const

Definition at line 203 of file class_library.cpp.

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

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

FindPart() [1/2]

LIB_PART * PART_LIB::FindPart

(

const wxString &

aName

)

const

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 209 of file class_library.cpp.

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

Referenced by PART_LIBS::FindLibPart(), and FindPart().

{
    LIB_ALIAS* alias = FindAlias( aName );

    if( alias != NULL )
        return alias->GetPart();

    return NULL;
}

FindPart() [2/2]

LIB_PART * PART_LIB::FindPart

(

const LIB_ID &

aLibId

)

const

Definition at line 220 of file class_library.cpp.

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

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

GetAliases()

void PART_LIB::GetAliases

(

std::vector< LIB_ALIAS *> &

aAliases

)

const

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, numEval::lhs, m_plugin, and m_properties.

Referenced by LEGACY_RESCUER::OpenRescueLibrary().

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

GetAliasNames()

void PART_LIB::GetAliasNames

(

wxArrayString &

aNames

)

const

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 PART_LIBS::FindLibraryNearEntries().

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

    aNames.Sort();
}

GetCount()

int PART_LIB::GetCount ( ) const

inline

Return the number of entries in the library.

Returns

The number of part and alias entries.

Definition at line 362 of file class_library.h.

References fileName, and m_plugin.

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

GetEntryTypePowerNames()

void PART_LIB::GetEntryTypePowerNames

(

wxArrayString &

aNames

)

const

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(), i, LIB_PART::IsPower(), m_plugin, and EDA_ITEM::Sort().

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

GetFullFileName()

wxString PART_LIB::GetFullFileName ( ) const

inline

Return the full file library name with path and extension.

Returns

wxString - Full library file name with path and extension.

Definition at line 475 of file class_library.h.

References fileName.

{ return fileName.GetFullPath(); }

GetLogicalName()

const wxString PART_LIB::GetLogicalName ( ) const

inline

Return the logical name of the library.

Returns

wxString - The logical name of this library.

Definition at line 482 of file class_library.h.

References fileName.

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

GetModHash()

int PART_LIB::GetModHash ( ) const

inline

Returns

a magic number that changes if the library has changed

Definition at line 337 of file class_library.h.

References m_mod_hash.

{ return m_mod_hash; }

GetName()

const wxString PART_LIB::GetName ( ) const

inline

Return the file name without path or extension.

Returns

Name of library file.

Definition at line 468 of file class_library.h.

References fileName.

Referenced by PART_LIBS::FindLibPart(), PART_LIBS::FindLibraryAlias(), PART_LIBS::FindLibraryNearEntries(), LIB_PART::GetLibraryName(), and PART_LIBS::GetLibraryNames().

{ return fileName.GetName(); }

GetPluginType()

SCH_IO_MGR::SCH_FILE_T PART_LIB::GetPluginType ( ) const

inline

Definition at line 339 of file class_library.h.

References m_pluginType.

{ return m_pluginType; }

HasPowerParts()

bool PART_LIB::HasPowerParts

(

)

const

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 226 of file class_library.cpp.

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

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

IsBuffering()

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 );
}

IsCache()

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(), and SCH_COMPONENT::GetMsgPanelInfo().

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

IsEmpty()

bool PART_LIB::IsEmpty ( ) const

inline

Get library entry status.

Returns

True if there are no entries in the library.

Definition at line 352 of file class_library.h.

References fileName, and m_plugin.

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

IsModified()

bool PART_LIB::IsModified ( ) const

inline

Definition at line 367 of file class_library.h.

References isModified.

    {
        return isModified;
    }

IsReadOnly()

bool PART_LIB::IsReadOnly ( ) const

inline

Returns

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

Definition at line 385 of file class_library.h.

References fileName.

{ return !fileName.IsFileWritable(); }

LoadLibrary()

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

static

Allocate and load a symbol 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 298 of file class_library.cpp.

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

Referenced by PART_LIBS::AddLibrary().

{
    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;
}

RemoveAlias()

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 261 of file class_library.cpp.

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

{
    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;
}

ReplacePart()

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 277 of file class_library.cpp.

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

{
    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;
}

Save()

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.

{
    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;
}

SetCache()

void PART_LIB::SetCache

(

)

Definition at line 128 of file class_library.cpp.

References SCH_LEGACY_PLUGIN::PropNoDocFile.

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

SetFileName()

void PART_LIB::SetFileName ( const wxString &  aFileName )

inline

Definition at line 345 of file class_library.h.

References fileName.

{ fileName = aFileName; }

SetPluginType()

void PART_LIB::SetPluginType

(

SCH_IO_MGR::SCH_FILE_T

aPluginType

)

Definition at line 112 of file class_library.cpp.

References m_plugin, and m_pluginType.

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

Member Data Documentation

fileName

wxFileName PART_LIB::fileName

private

Library file name.

Definition at line 317 of file class_library.h.

Referenced by AddPart(), Create(), FindAlias(), GetAliases(), GetAliasNames(), GetCount(), GetEntryTypePowerNames(), GetFullFileName(), GetLogicalName(), GetName(), HasPowerParts(), IsEmpty(), IsReadOnly(), PART_LIB(), RemoveAlias(), ReplacePart(), Save(), and SetFileName().

header

wxString PART_LIB::header

private

first line of loaded library.

Definition at line 321 of file class_library.h.

isModified

bool PART_LIB::isModified

private

Library modification status.

Definition at line 322 of file class_library.h.

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

m_mod_hash

int PART_LIB::m_mod_hash

private

incremented each time library is changed.

Definition at line 323 of file class_library.h.

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

m_plugin

std::unique_ptr< SCH_PLUGIN > PART_LIB::m_plugin

private

Definition at line 326 of file class_library.h.

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

m_pluginType

SCH_IO_MGR::SCH_FILE_T PART_LIB::m_pluginType

private

Definition at line 325 of file class_library.h.

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

m_properties

std::unique_ptr< PROPERTIES > PART_LIB::m_properties

private

Library properties.

Definition at line 327 of file class_library.h.

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

timeStamp

wxDateTime PART_LIB::timeStamp

private

Library save time and date.

Definition at line 318 of file class_library.h.

Referenced by PART_LIB().

type

int PART_LIB::type

private

Library type indicator.

Definition at line 316 of file class_library.h.

Referenced by PART_LIB().

versionMajor

int PART_LIB::versionMajor

private

Library major version number.

Definition at line 319 of file class_library.h.

Referenced by PART_LIB().

versionMinor

int PART_LIB::versionMinor

private

Library minor version number.

Definition at line 320 of file class_library.h.

Referenced by PART_LIB().

---

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

• class_library.h
• class_library.cpp