KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SCH_LIB_PLUGIN_CACHE Class Referenceabstract

A base cache assistant implementation for the symbol library portion of the SCH_PLUGIN API. More...

#include <sch_lib_plugin_cache.h>

Inheritance diagram for SCH_LIB_PLUGIN_CACHE:
ALTIUM_LIB_PLUGIN_CACHE SCH_LEGACY_PLUGIN_CACHE SCH_SEXPR_PLUGIN_CACHE

Public Member Functions

 SCH_LIB_PLUGIN_CACHE (const wxString &aLibraryPath)
 
virtual ~SCH_LIB_PLUGIN_CACHE ()
 
void IncrementModifyHash ()
 
int GetModifyHash ()
 
virtual void Save (const std::optional< bool > &aOpt=std::nullopt)
 Save the entire library to file m_libFileName;. More...
 
virtual void Load ()=0
 
virtual void AddSymbol (const LIB_SYMBOL *aSymbol)
 
virtual void DeleteSymbol (const wxString &aName)=0
 
virtual LIB_SYMBOL * GetSymbol (const wxString &aName)
 
wxFileName GetRealFile () const
 
wxDateTime GetLibModificationTime ()
 
bool IsFile (const wxString &aFullPathAndFileName) const
 
bool IsFileChanged () const
 
void SetModified (bool aModified=true)
 
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
 
wxDateTime m_fileModTime
 
LIB_SYMBOL_MAP m_symbols
 
bool m_isWritable
 
bool m_isModified
 
SCH_LIB_TYPE m_libType
 

Detailed Description

A base cache assistant implementation for the symbol library portion of the SCH_PLUGIN API.

Definition at line 40 of file sch_lib_plugin_cache.h.

Constructor & Destructor Documentation

◆ SCH_LIB_PLUGIN_CACHE()

SCH_LIB_PLUGIN_CACHE::SCH_LIB_PLUGIN_CACHE ( const wxString &  aLibraryPath)

Definition at line 28 of file sch_lib_plugin_cache.cpp.

References m_libType.

◆ ~SCH_LIB_PLUGIN_CACHE()

SCH_LIB_PLUGIN_CACHE::~SCH_LIB_PLUGIN_CACHE ( )
virtual

Definition at line 39 of file sch_lib_plugin_cache.cpp.

References m_symbols.

Member Function Documentation

◆ AddSymbol()

void SCH_LIB_PLUGIN_CACHE::AddSymbol ( const LIB_SYMBOL *  aSymbol)
virtual

Definition at line 161 of file sch_lib_plugin_cache.cpp.

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

Referenced by SCH_SEXPR_PLUGIN::SaveSymbol(), and SCH_LEGACY_PLUGIN::SaveSymbol().

◆ DeleteSymbol()

virtual void SCH_LIB_PLUGIN_CACHE::DeleteSymbol ( const wxString &  aName)
pure virtual

Implemented in SCH_SEXPR_PLUGIN_CACHE, and SCH_LEGACY_PLUGIN_CACHE.

◆ GetFileName()

wxString SCH_LIB_PLUGIN_CACHE::GetFileName ( ) const
inline

Definition at line 88 of file sch_lib_plugin_cache.h.

References m_libFileName.

Referenced by SCH_SEXPR_PLUGIN::SaveLibrary(), and SCH_LEGACY_PLUGIN::SaveLibrary().

◆ GetLibModificationTime()

wxDateTime SCH_LIB_PLUGIN_CACHE::GetLibModificationTime ( )

Definition at line 65 of file sch_lib_plugin_cache.cpp.

References GetRealFile(), and m_isWritable.

Referenced by SCH_SEXPR_PLUGIN_CACHE::Load(), and SCH_LEGACY_PLUGIN_CACHE::Load().

◆ GetLogicalName()

wxString SCH_LIB_PLUGIN_CACHE::GetLogicalName ( ) const
inline

Definition at line 84 of file sch_lib_plugin_cache.h.

References m_libFileName.

◆ GetModifyHash()

int SCH_LIB_PLUGIN_CACHE::GetModifyHash ( )
inline

Definition at line 52 of file sch_lib_plugin_cache.h.

References m_modHash, and m_modHashMutex.

Referenced by SCH_SEXPR_PLUGIN::GetModifyHash(), and SCH_LEGACY_PLUGIN::GetModifyHash().

◆ GetRealFile()

wxFileName SCH_LIB_PLUGIN_CACHE::GetRealFile ( ) const

Definition at line 55 of file sch_lib_plugin_cache.cpp.

References m_libFileName, and WX_FILENAME::ResolvePossibleSymlinks().

Referenced by GetLibModificationTime(), IsFileChanged(), SCH_LEGACY_PLUGIN_CACHE::Save(), and SCH_SEXPR_PLUGIN_CACHE::Save().

◆ GetSymbol()

LIB_SYMBOL * SCH_LIB_PLUGIN_CACHE::GetSymbol ( const wxString &  aName)
virtual

Definition at line 178 of file sch_lib_plugin_cache.cpp.

References m_symbols.

Referenced by EESCHEMA_JOBS_HANDLER::JobSymExportSvg().

◆ GetSymbolMap()

const LIB_SYMBOL_MAP & SCH_LIB_PLUGIN_CACHE::GetSymbolMap ( ) const
inline

Definition at line 90 of file sch_lib_plugin_cache.h.

References m_symbols.

Referenced by EESCHEMA_JOBS_HANDLER::JobSymExportSvg().

◆ IncrementModifyHash()

void SCH_LIB_PLUGIN_CACHE::IncrementModifyHash ( )
inline

Definition at line 46 of file sch_lib_plugin_cache.h.

References m_modHash, and m_modHashMutex.

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

◆ IsFile()

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

Definition at line 77 of file sch_lib_plugin_cache.cpp.

References m_fileName.

Referenced by SCH_SEXPR_PLUGIN::cacheLib(), SCH_LEGACY_PLUGIN::cacheLib(), SCH_SEXPR_PLUGIN::DeleteSymbolLib(), SCH_LEGACY_PLUGIN::DeleteSymbolLib(), SCH_SEXPR_PLUGIN::SaveLibrary(), and SCH_LEGACY_PLUGIN::SaveLibrary().

◆ IsFileChanged()

bool SCH_LIB_PLUGIN_CACHE::IsFileChanged ( ) const

Definition at line 83 of file sch_lib_plugin_cache.cpp.

References GetRealFile(), and m_fileModTime.

Referenced by SCH_SEXPR_PLUGIN::cacheLib(), and SCH_LEGACY_PLUGIN::cacheLib().

◆ Load()

virtual void SCH_LIB_PLUGIN_CACHE::Load ( )
pure virtual

Implemented in ALTIUM_LIB_PLUGIN_CACHE, SCH_SEXPR_PLUGIN_CACHE, and SCH_LEGACY_PLUGIN_CACHE.

◆ removeSymbol()

LIB_SYMBOL * SCH_LIB_PLUGIN_CACHE::removeSymbol ( LIB_SYMBOL *  aAlias)
protected

Definition at line 94 of file sch_lib_plugin_cache.cpp.

References LIB_SYMBOL::AddDrawItem(), EDA_ITEM::Clone(), LIB_SYMBOL::FindField(), LIB_FIELD::GetCanonicalName(), LIB_SYMBOL::GetDrawItems(), LIB_SYMBOL::GetName(), IncrementModifyHash(), LIB_SYMBOL::IsRoot(), LIB_FIELD_T, m_isModified, m_libFileName, m_symbols, EDA_ITEM::SetParent(), and LIB_SYMBOL::SharedPtr().

Referenced by AddSymbol().

◆ Save()

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

Save the entire library to file m_libFileName;.

Reimplemented in SCH_LEGACY_PLUGIN_CACHE, and SCH_SEXPR_PLUGIN_CACHE.

Definition at line 49 of file sch_lib_plugin_cache.cpp.

◆ SetFileName()

void SCH_LIB_PLUGIN_CACHE::SetFileName ( const wxString &  aFileName)
inline

Definition at line 86 of file sch_lib_plugin_cache.h.

References m_libFileName.

Referenced by EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), SCH_SEXPR_PLUGIN::SaveLibrary(), and SCH_LEGACY_PLUGIN::SaveLibrary().

◆ SetModified()

void SCH_LIB_PLUGIN_CACHE::SetModified ( bool  aModified = true)
inline

Definition at line 82 of file sch_lib_plugin_cache.h.

References m_isModified.

Referenced by SCH_SEXPR_PLUGIN::CreateSymbolLib(), SCH_LEGACY_PLUGIN::CreateSymbolLib(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), SCH_SEXPR_PLUGIN::SaveLibrary(), and SCH_LEGACY_PLUGIN::SaveLibrary().

Member Data Documentation

◆ m_fileModTime

wxDateTime SCH_LIB_PLUGIN_CACHE::m_fileModTime
protected

Definition at line 100 of file sch_lib_plugin_cache.h.

Referenced by IsFileChanged(), SCH_SEXPR_PLUGIN_CACHE::Load(), SCH_LEGACY_PLUGIN_CACHE::Load(), SCH_LEGACY_PLUGIN_CACHE::Save(), and SCH_SEXPR_PLUGIN_CACHE::Save().

◆ m_fileName

wxString SCH_LIB_PLUGIN_CACHE::m_fileName
protected

Definition at line 98 of file sch_lib_plugin_cache.h.

Referenced by IsFile().

◆ m_isModified

bool SCH_LIB_PLUGIN_CACHE::m_isModified
protected

Definition at line 103 of file sch_lib_plugin_cache.h.

Referenced by AddSymbol(), SCH_SEXPR_PLUGIN_CACHE::DeleteSymbol(), SCH_LEGACY_PLUGIN_CACHE::DeleteSymbol(), removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::Save(), SCH_SEXPR_PLUGIN_CACHE::Save(), and SetModified().

◆ m_isWritable

bool SCH_LIB_PLUGIN_CACHE::m_isWritable
protected

Definition at line 102 of file sch_lib_plugin_cache.h.

Referenced by GetLibModificationTime().

◆ m_libFileName

wxFileName SCH_LIB_PLUGIN_CACHE::m_libFileName
protected

Definition at line 99 of file sch_lib_plugin_cache.h.

Referenced by SCH_SEXPR_PLUGIN_CACHE::DeleteSymbol(), SCH_LEGACY_PLUGIN_CACHE::DeleteSymbol(), GetFileName(), GetLogicalName(), GetRealFile(), SCH_SEXPR_PLUGIN_CACHE::Load(), SCH_LEGACY_PLUGIN_CACHE::Load(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::saveDocFile(), and SetFileName().

◆ m_libType

SCH_LIB_TYPE SCH_LIB_PLUGIN_CACHE::m_libType
protected

Definition at line 104 of file sch_lib_plugin_cache.h.

Referenced by SCH_LEGACY_PLUGIN_CACHE::Load(), and SCH_LIB_PLUGIN_CACHE().

◆ m_modHash

int SCH_LIB_PLUGIN_CACHE::m_modHash
protected

Definition at line 95 of file sch_lib_plugin_cache.h.

Referenced by SCH_SEXPR_PLUGIN_CACHE::DeleteSymbol(), GetModifyHash(), IncrementModifyHash(), and SCH_SEXPR_PLUGIN_CACHE::Load().

◆ m_modHashMutex

std::mutex SCH_LIB_PLUGIN_CACHE::m_modHashMutex
protected

Definition at line 96 of file sch_lib_plugin_cache.h.

Referenced by GetModifyHash(), and IncrementModifyHash().

◆ m_symbols

LIB_SYMBOL_MAP SCH_LIB_PLUGIN_CACHE::m_symbols
protected

Definition at line 101 of file sch_lib_plugin_cache.h.

Referenced by AddSymbol(), SCH_SEXPR_PLUGIN_CACHE::DeleteSymbol(), SCH_LEGACY_PLUGIN_CACHE::DeleteSymbol(), SCH_SEXPR_PLUGIN::EnumerateSymbolLib(), SCH_LEGACY_PLUGIN::EnumerateSymbolLib(), SCH_SEXPR_PLUGIN::GetAvailableSymbolFields(), GetSymbol(), GetSymbolMap(), SCH_SEXPR_PLUGIN_CACHE::Load(), SCH_LEGACY_PLUGIN_CACHE::Load(), SCH_LEGACY_PLUGIN_CACHE::loadDocs(), SCH_SEXPR_PLUGIN::LoadSymbol(), SCH_LEGACY_PLUGIN::LoadSymbol(), removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::Save(), SCH_SEXPR_PLUGIN_CACHE::Save(), SCH_LEGACY_PLUGIN_CACHE::saveDocFile(), and ~SCH_LIB_PLUGIN_CACHE().

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