SCH_IO_ALTIUM_LIB_CACHE Class Reference

A cache assistant for Altium symbol libraries. More...

#include <sch_io_altium_lib_cache.h>

Inheritance diagram for SCH_IO_ALTIUM_LIB_CACHE:

Public Member Functions
	SCH_IO_ALTIUM_LIB_CACHE (const wxString &aLibraryPath)
virtual	~SCH_IO_ALTIUM_LIB_CACHE ()
void	Load () override
void	IncrementModifyHash ()
int	GetModifyHash ()
virtual void	Save (const std::optional< bool > &aOpt=std::nullopt)
	Save the entire library to file m_libFileName;.
virtual void	AddSymbol (const LIB_SYMBOL *aSymbol)
virtual void	DeleteSymbol (const wxString &aName)=0
virtual LIB_SYMBOL *	GetSymbol (const wxString &aName)
wxFileName	GetRealFile () const
long long	GetLibModificationTime ()
bool	IsFile (const wxString &aFullPathAndFileName) const
bool	IsFileChanged () const
void	SetModified (bool aModified=true)
bool	HasParseError () const
void	SetParseError (bool aHasError=true)
	Set the parse error state.
wxString	GetLogicalName () const
void	SetFileName (const wxString &aFileName)
wxString	GetFileName () const
const LIB_SYMBOL_MAP &	GetSymbolMap () const

Protected Member Functions
LIB_SYMBOL *	removeSymbol (LIB_SYMBOL *aAlias)

Protected Attributes
int	m_modHash
std::mutex	m_modHashMutex
wxString	m_fileName
wxFileName	m_libFileName
long long	m_fileModTime
LIB_SYMBOL_MAP	m_symbols
std::map< wxString, wxString >	m_symbolSourceFiles
	For folder-based libraries, track which source file each symbol was loaded from.
bool	m_isWritable
bool	m_isModified
bool	m_hasParseError
SCH_LIB_TYPE	m_libType

Private Attributes
friend	SCH_IO_KICAD_SEXPR

Detailed Description

A cache assistant for Altium symbol libraries.

Definition at line 32 of file sch_io_altium_lib_cache.h.

Constructor & Destructor Documentation

SCH_IO_ALTIUM_LIB_CACHE()

SCH_IO_ALTIUM_LIB_CACHE::SCH_IO_ALTIUM_LIB_CACHE

(

const wxString &

aLibraryPath

)

~SCH_IO_ALTIUM_LIB_CACHE()

virtual SCH_IO_ALTIUM_LIB_CACHE::~SCH_IO_ALTIUM_LIB_CACHE ( )

virtual

Member Function Documentation

AddSymbol()

void SCH_IO_LIB_CACHE::AddSymbol ( const LIB_SYMBOL * aSymbol )

virtualinherited

Definition at line 211 of file sch_io_lib_cache.cpp.

References LIB_SYMBOL::GetName(), IncrementModifyHash(), m_isModified, m_symbols, name, and removeSymbol().

DeleteSymbol()

virtual void SCH_IO_LIB_CACHE::DeleteSymbol ( const wxString & aName )

pure virtualinherited

Implemented in SCH_IO_KICAD_LEGACY_LIB_CACHE, and SCH_IO_KICAD_SEXPR_LIB_CACHE.

GetFileName()

wxString SCH_IO_LIB_CACHE::GetFileName ( ) const

inlineinherited

Definition at line 104 of file sch_io_lib_cache.h.

References m_libFileName.

GetLibModificationTime()

long long SCH_IO_LIB_CACHE::GetLibModificationTime ( )

inherited

Definition at line 83 of file sch_io_lib_cache.cpp.

References GetRealFile(), FILEEXT::KiCadSymbolLibFileExtension, m_isWritable, and KIPLATFORM::IO::TimestampDir().

Referenced by SCH_IO_KICAD_LEGACY_LIB_CACHE::Load(), SCH_IO_KICAD_SEXPR_LIB_CACHE::Load(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::Save().

GetLogicalName()

wxString SCH_IO_LIB_CACHE::GetLogicalName ( ) const

inlineinherited

Definition at line 100 of file sch_io_lib_cache.h.

References m_libFileName.

GetModifyHash()

int SCH_IO_LIB_CACHE::GetModifyHash ( )

inlineinherited

Definition at line 53 of file sch_io_lib_cache.h.

References m_modHash, and m_modHashMutex.

GetRealFile()

wxFileName SCH_IO_LIB_CACHE::GetRealFile ( ) const

inherited

Definition at line 66 of file sch_io_lib_cache.cpp.

References m_libFileName, and WX_FILENAME::ResolvePossibleSymlinks().

Referenced by GetLibModificationTime(), IsFileChanged(), SCH_IO_KICAD_LEGACY_LIB_CACHE::Save(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::Save().

GetSymbol()

LIB_SYMBOL * SCH_IO_LIB_CACHE::GetSymbol ( const wxString & aName )

virtualinherited

Definition at line 228 of file sch_io_lib_cache.cpp.

References m_symbols.

Referenced by EESCHEMA_JOBS_HANDLER::JobSymExportSvg().

GetSymbolMap()

const LIB_SYMBOL_MAP & SCH_IO_LIB_CACHE::GetSymbolMap ( ) const

inlineinherited

Definition at line 106 of file sch_io_lib_cache.h.

References m_symbols.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and EESCHEMA_JOBS_HANDLER::JobSymExportSvg().

HasParseError()

bool SCH_IO_LIB_CACHE::HasParseError ( ) const

inlineinherited

Returns

true if the library had a parse error during loading.

When a parse error occurs, only symbols before the error are loaded. Saving a library in this state would permanently lose symbols after the error.

Definition at line 91 of file sch_io_lib_cache.h.

References m_hasParseError.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::Save().

IncrementModifyHash()

void SCH_IO_LIB_CACHE::IncrementModifyHash ( )

inlineinherited

Definition at line 47 of file sch_io_lib_cache.h.

References m_modHash, and m_modHashMutex.

Referenced by AddSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::DeleteSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::DeleteSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::Load(), SCH_IO_KICAD_SEXPR_LIB_CACHE::Load(), and removeSymbol().

IsFile()

bool SCH_IO_LIB_CACHE::IsFile ( const wxString & aFullPathAndFileName ) const

inherited

Definition at line 103 of file sch_io_lib_cache.cpp.

References m_fileName.

IsFileChanged()

bool SCH_IO_LIB_CACHE::IsFileChanged ( ) const

inherited

Definition at line 123 of file sch_io_lib_cache.cpp.

References GetRealFile(), FILEEXT::KiCadSymbolLibFileExtension, m_fileModTime, and KIPLATFORM::IO::TimestampDir().

Load()

void SCH_IO_ALTIUM_LIB_CACHE::Load ( )

overridevirtual

Implements SCH_IO_LIB_CACHE.

removeSymbol()

LIB_SYMBOL * SCH_IO_LIB_CACHE::removeSymbol ( LIB_SYMBOL * aAlias )

protectedinherited

Definition at line 144 of file sch_io_lib_cache.cpp.

References LIB_SYMBOL::AddDrawItem(), EDA_ITEM::Clone(), SCH_FIELD::GetCanonicalName(), LIB_SYMBOL::GetDrawItems(), LIB_SYMBOL::GetField(), LIB_SYMBOL::GetName(), IncrementModifyHash(), LIB_SYMBOL::IsRoot(), m_isModified, m_libFileName, m_symbols, SCH_FIELD_T, EDA_ITEM::SetParent(), and LIB_SYMBOL::SharedPtr().

Referenced by AddSymbol().

Save()

void SCH_IO_LIB_CACHE::Save ( const std::optional< bool > & aOpt = std::nullopt )

virtualinherited

Save the entire library to file m_libFileName;.

Reimplemented in SCH_IO_KICAD_LEGACY_LIB_CACHE, and SCH_IO_KICAD_SEXPR_LIB_CACHE.

Definition at line 60 of file sch_io_lib_cache.cpp.

SetFileName()

void SCH_IO_LIB_CACHE::SetFileName ( const wxString & aFileName )

inherited

Definition at line 109 of file sch_io_lib_cache.cpp.

References m_fileName, and m_libFileName.

Referenced by EESCHEMA_JOBS_HANDLER::JobSymUpgrade().

SetModified()

void SCH_IO_LIB_CACHE::SetModified ( bool aModified = true )

inlineinherited

Definition at line 83 of file sch_io_lib_cache.h.

References m_isModified.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and EESCHEMA_JOBS_HANDLER::JobSymUpgrade().

SetParseError()

void SCH_IO_LIB_CACHE::SetParseError ( bool aHasError = true )

inlineinherited

Set the parse error state.

Parameters

aHasError

true if the library had a parse error during loading.

Definition at line 98 of file sch_io_lib_cache.h.

References m_hasParseError.

Referenced by SCH_IO_KICAD_SEXPR_LIB_CACHE::Load().

Member Data Documentation

m_fileModTime

long long SCH_IO_LIB_CACHE::m_fileModTime

protectedinherited

Definition at line 116 of file sch_io_lib_cache.h.

Referenced by IsFileChanged(), SCH_IO_KICAD_LEGACY_LIB_CACHE::Load(), SCH_IO_KICAD_SEXPR_LIB_CACHE::Load(), SCH_IO_KICAD_LEGACY_LIB_CACHE::Save(), SCH_IO_KICAD_SEXPR_LIB_CACHE::Save(), and SCH_IO_LIB_CACHE().

m_fileName

wxString SCH_IO_LIB_CACHE::m_fileName

protectedinherited

Definition at line 114 of file sch_io_lib_cache.h.

Referenced by IsFile(), SCH_IO_LIB_CACHE(), and SetFileName().

m_hasParseError

bool SCH_IO_LIB_CACHE::m_hasParseError

protectedinherited

Definition at line 127 of file sch_io_lib_cache.h.

Referenced by HasParseError(), SCH_IO_LIB_CACHE(), and SetParseError().

m_isModified

bool SCH_IO_LIB_CACHE::m_isModified

protectedinherited

Definition at line 126 of file sch_io_lib_cache.h.

Referenced by AddSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::DeleteSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::DeleteSymbol(), removeSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::Save(), SCH_IO_KICAD_SEXPR_LIB_CACHE::Save(), SCH_IO_LIB_CACHE(), and SetModified().

m_isWritable

bool SCH_IO_LIB_CACHE::m_isWritable

protectedinherited

Definition at line 125 of file sch_io_lib_cache.h.

Referenced by GetLibModificationTime(), and SCH_IO_LIB_CACHE().

m_libFileName

wxFileName SCH_IO_LIB_CACHE::m_libFileName

protectedinherited

Definition at line 115 of file sch_io_lib_cache.h.

Referenced by SCH_IO_KICAD_LEGACY_LIB_CACHE::DeleteSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::DeleteSymbol(), GetFileName(), GetLogicalName(), GetRealFile(), SCH_IO_KICAD_SEXPR_LIB_CACHE::isLibraryPathValid(), SCH_IO_KICAD_LEGACY_LIB_CACHE::Load(), SCH_IO_KICAD_SEXPR_LIB_CACHE::Load(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadDocs(), removeSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::Save(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveDocFile(), SCH_IO_LIB_CACHE(), SetFileName(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::updateParentSymbolLinks().

m_libType

SCH_LIB_TYPE SCH_IO_LIB_CACHE::m_libType

protectedinherited

Definition at line 128 of file sch_io_lib_cache.h.

Referenced by SCH_IO_KICAD_LEGACY_LIB_CACHE::Load(), and SCH_IO_LIB_CACHE().

m_modHash

int SCH_IO_LIB_CACHE::m_modHash

protectedinherited

Definition at line 111 of file sch_io_lib_cache.h.

Referenced by GetModifyHash(), IncrementModifyHash(), and SCH_IO_LIB_CACHE().

m_modHashMutex

std::mutex SCH_IO_LIB_CACHE::m_modHashMutex

protectedinherited

Definition at line 112 of file sch_io_lib_cache.h.

Referenced by GetModifyHash(), and IncrementModifyHash().

m_symbols

LIB_SYMBOL_MAP SCH_IO_LIB_CACHE::m_symbols

protectedinherited

Definition at line 117 of file sch_io_lib_cache.h.

Referenced by AddSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::DeleteSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::DeleteSymbol(), GetSymbol(), GetSymbolMap(), SCH_IO_KICAD_LEGACY_LIB_CACHE::Load(), SCH_IO_KICAD_SEXPR_LIB_CACHE::Load(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadDocs(), removeSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::Save(), SCH_IO_KICAD_SEXPR_LIB_CACHE::Save(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveDocFile(), SCH_IO_KICAD_SEXPR_LIB_CACHE::updateParentSymbolLinks(), and ~SCH_IO_LIB_CACHE().

m_symbolSourceFiles

std::map<wxString, wxString> SCH_IO_LIB_CACHE::m_symbolSourceFiles

protectedinherited

For folder-based libraries, track which source file each symbol was loaded from.

Key is symbol name, value is the full path to the source file. This allows saving symbols back to their original files rather than creating individual files for each symbol.

Definition at line 123 of file sch_io_lib_cache.h.

Referenced by SCH_IO_KICAD_SEXPR_LIB_CACHE::Load(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::Save().

SCH_IO_KICAD_SEXPR

friend SCH_IO_ALTIUM_LIB_CACHE::SCH_IO_KICAD_SEXPR

private

Definition at line 41 of file sch_io_altium_lib_cache.h.

---

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

• sch_io_altium_lib_cache.h