KiCad PCB EDA Suite
Loading...
Searching...
No Matches
SCH_IO_KICAD_SEXPR_LIB_CACHE Class Reference

A cache assistant for the KiCad s-expression symbol libraries. More...

#include <sch_io_kicad_sexpr_lib_cache.h>

Inheritance diagram for SCH_IO_KICAD_SEXPR_LIB_CACHE:
SCH_IO_LIB_CACHE

Public Member Functions

 SCH_IO_KICAD_SEXPR_LIB_CACHE (const wxString &aLibraryPath)
 
virtual ~SCH_IO_KICAD_SEXPR_LIB_CACHE ()
 
void Save (const std::optional< bool > &aOpt=std::nullopt) override
 Save the entire library to file m_libFileName;.
 
void Load () override
 
void DeleteSymbol (const wxString &aName) override
 
void SetFileFormatVersionAtLoad (int aVersion)
 
int GetFileFormatVersionAtLoad () const
 
void IncrementModifyHash ()
 
int GetModifyHash ()
 
virtual void AddSymbol (const LIB_SYMBOL *aSymbol)
 
virtual LIB_SYMBOLGetSymbol (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_MAPGetSymbolMap () const
 

Static Public Member Functions

static void SaveSymbol (LIB_SYMBOL *aSymbol, OUTPUTFORMATTER &aFormatter, int aNestLevel=0, const wxString &aLibName=wxEmptyString, bool aIncludeData=true)
 

Protected Member Functions

LIB_SYMBOLremoveSymbol (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
 

Static Private Member Functions

static void saveSymbolDrawItem (SCH_ITEM *aItem, OUTPUTFORMATTER &aFormatter, int aNestLevel)
 
static void saveField (SCH_FIELD *aField, OUTPUTFORMATTER &aFormatter, int aNestLevel)
 
static void savePin (SCH_PIN *aPin, OUTPUTFORMATTER &aFormatter, int aNestLevel=0)
 
static void saveText (SCH_TEXT *aText, OUTPUTFORMATTER &aFormatter, int aNestLevel=0)
 
static void saveTextBox (SCH_TEXTBOX *aTextBox, OUTPUTFORMATTER &aFormatter, int aNestLevel=0)
 
static void saveDcmInfoAsFields (LIB_SYMBOL *aSymbol, OUTPUTFORMATTER &aFormatter, int &aNextFreeFieldId, int aNestLevel)
 

Private Attributes

friend SCH_IO_KICAD_SEXPR
 
int m_fileFormatVersionAtLoad
 

Detailed Description

A cache assistant for the KiCad s-expression symbol libraries.

Definition at line 37 of file sch_io_kicad_sexpr_lib_cache.h.

Constructor & Destructor Documentation

◆ SCH_IO_KICAD_SEXPR_LIB_CACHE()

SCH_IO_KICAD_SEXPR_LIB_CACHE::SCH_IO_KICAD_SEXPR_LIB_CACHE ( const wxString &  aLibraryPath)

Definition at line 38 of file sch_io_kicad_sexpr_lib_cache.cpp.

References m_fileFormatVersionAtLoad.

◆ ~SCH_IO_KICAD_SEXPR_LIB_CACHE()

SCH_IO_KICAD_SEXPR_LIB_CACHE::~SCH_IO_KICAD_SEXPR_LIB_CACHE ( )
virtual

Definition at line 45 of file sch_io_kicad_sexpr_lib_cache.cpp.

Member Function Documentation

◆ AddSymbol()

◆ DeleteSymbol()

void SCH_IO_KICAD_SEXPR_LIB_CACHE::DeleteSymbol ( const wxString &  aName)
overridevirtual

◆ GetFileFormatVersionAtLoad()

int SCH_IO_KICAD_SEXPR_LIB_CACHE::GetFileFormatVersionAtLoad ( ) const
inline

◆ GetFileName()

wxString SCH_IO_LIB_CACHE::GetFileName ( ) const
inlineinherited

◆ GetLibModificationTime()

wxDateTime SCH_IO_LIB_CACHE::GetLibModificationTime ( )
inherited

◆ GetLogicalName()

wxString SCH_IO_LIB_CACHE::GetLogicalName ( ) const
inlineinherited

Definition at line 84 of file sch_io_lib_cache.h.

References SCH_IO_LIB_CACHE::m_libFileName.

◆ GetModifyHash()

int SCH_IO_LIB_CACHE::GetModifyHash ( )
inlineinherited

◆ GetRealFile()

◆ GetSymbol()

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

Definition at line 178 of file sch_io_lib_cache.cpp.

References SCH_IO_LIB_CACHE::m_symbols.

Referenced by EESCHEMA_JOBS_HANDLER::JobSymExportSvg().

◆ GetSymbolMap()

const LIB_SYMBOL_MAP & SCH_IO_LIB_CACHE::GetSymbolMap ( ) const
inlineinherited

Definition at line 90 of file sch_io_lib_cache.h.

References SCH_IO_LIB_CACHE::m_symbols.

Referenced by EESCHEMA_JOBS_HANDLER::JobSymExportSvg().

◆ IncrementModifyHash()

◆ IsFile()

◆ IsFileChanged()

bool SCH_IO_LIB_CACHE::IsFileChanged ( ) const
inherited

◆ Load()

◆ removeSymbol()

◆ Save()

◆ saveDcmInfoAsFields()

void SCH_IO_KICAD_SEXPR_LIB_CACHE::saveDcmInfoAsFields ( LIB_SYMBOL aSymbol,
OUTPUTFORMATTER aFormatter,
int &  aNextFreeFieldId,
int  aNestLevel 
)
staticprivate

◆ saveField()

◆ savePin()

◆ SaveSymbol()

◆ saveSymbolDrawItem()

◆ saveText()

◆ saveTextBox()

◆ SetFileFormatVersionAtLoad()

void SCH_IO_KICAD_SEXPR_LIB_CACHE::SetFileFormatVersionAtLoad ( int  aVersion)
inline

Definition at line 57 of file sch_io_kicad_sexpr_lib_cache.h.

References m_fileFormatVersionAtLoad.

Referenced by Load().

◆ SetFileName()

void SCH_IO_LIB_CACHE::SetFileName ( const wxString &  aFileName)
inlineinherited

◆ SetModified()

Member Data Documentation

◆ m_fileFormatVersionAtLoad

int SCH_IO_KICAD_SEXPR_LIB_CACHE::m_fileFormatVersionAtLoad
private

◆ m_fileModTime

wxDateTime SCH_IO_LIB_CACHE::m_fileModTime
protectedinherited

◆ m_fileName

wxString SCH_IO_LIB_CACHE::m_fileName
protectedinherited

Definition at line 98 of file sch_io_lib_cache.h.

Referenced by SCH_IO_LIB_CACHE::IsFile().

◆ m_isModified

◆ m_isWritable

bool SCH_IO_LIB_CACHE::m_isWritable
protectedinherited

Definition at line 102 of file sch_io_lib_cache.h.

Referenced by SCH_IO_LIB_CACHE::GetLibModificationTime().

◆ m_libFileName

◆ m_libType

SCH_LIB_TYPE SCH_IO_LIB_CACHE::m_libType
protectedinherited

◆ m_modHash

int SCH_IO_LIB_CACHE::m_modHash
protectedinherited

◆ m_modHashMutex

std::mutex SCH_IO_LIB_CACHE::m_modHashMutex
protectedinherited

◆ m_symbols

◆ SCH_IO_KICAD_SEXPR

friend SCH_IO_KICAD_SEXPR_LIB_CACHE::SCH_IO_KICAD_SEXPR
private

Definition at line 61 of file sch_io_kicad_sexpr_lib_cache.h.


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