KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
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_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
 

Static Public Member Functions

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

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 Member Functions

void updateParentSymbolLinks ()
 Update the parent symbol links for derived symbols.
 
void formatLibraryHeader (OUTPUTFORMATTER &aFormatter)
 
bool isLibraryPathValid () const
 

Static Private Member Functions

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

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 44 of file sch_io_kicad_sexpr_lib_cache.cpp.

References m_fileFormatVersionAtLoad, and SCH_IO_LIB_CACHE::SCH_IO_LIB_CACHE().

◆ ~SCH_IO_KICAD_SEXPR_LIB_CACHE()

SCH_IO_KICAD_SEXPR_LIB_CACHE::~SCH_IO_KICAD_SEXPR_LIB_CACHE ( )
virtual

Definition at line 51 of file sch_io_kicad_sexpr_lib_cache.cpp.

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

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

Implements SCH_IO_LIB_CACHE.

Definition at line 772 of file sch_io_kicad_sexpr_lib_cache.cpp.

References _, SCH_IO_LIB_CACHE::IncrementModifyHash(), LIB_SYMBOL::IsRoot(), SCH_IO_LIB_CACHE::m_isModified, SCH_IO_LIB_CACHE::m_libFileName, SCH_IO_LIB_CACHE::m_symbols, LIB_SYMBOL::SharedPtr(), and THROW_IO_ERROR.

◆ formatLibraryHeader()

void SCH_IO_KICAD_SEXPR_LIB_CACHE::formatLibraryHeader ( OUTPUTFORMATTER & aFormatter)
private

Definition at line 842 of file sch_io_kicad_sexpr_lib_cache.cpp.

References GetMajorMinorVersion(), OUTPUTFORMATTER::Print(), and SEXPR_SYMBOL_LIB_FILE_VERSION.

Referenced by Save().

◆ GetFileFormatVersionAtLoad()

int SCH_IO_KICAD_SEXPR_LIB_CACHE::GetFileFormatVersionAtLoad ( ) const
inline

Definition at line 58 of file sch_io_kicad_sexpr_lib_cache.h.

References m_fileFormatVersionAtLoad.

Referenced by EESCHEMA_JOBS_HANDLER::JobSymUpgrade().

◆ 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().

◆ isLibraryPathValid()

bool SCH_IO_KICAD_SEXPR_LIB_CACHE::isLibraryPathValid ( ) const
private

Definition at line 851 of file sch_io_kicad_sexpr_lib_cache.cpp.

References SCH_IO_LIB_CACHE::m_libFileName.

Referenced by Load().

◆ Load()

void SCH_IO_KICAD_SEXPR_LIB_CACHE::Load ( )
overridevirtual

Implements SCH_IO_LIB_CACHE.

Definition at line 56 of file sch_io_kicad_sexpr_lib_cache.cpp.

References _, SCH_IO_LIB_CACHE::GetLibModificationTime(), SCH_IO_KICAD_SEXPR_PARSER::GetParsedRequiredVersion(), SCH_IO_KICAD_SEXPR_PARSER::GetParseWarnings(), SCH_IO_LIB_CACHE::IncrementModifyHash(), isLibraryPathValid(), FILEEXT::KiCadSymbolLibFileExtension, SCH_IO_LIB_CACHE::m_fileModTime, SCH_IO_LIB_CACHE::m_libFileName, SCH_IO_LIB_CACHE::m_symbols, SCH_IO_LIB_CACHE::m_symbolSourceFiles, name, SCH_IO_KICAD_SEXPR_PARSER::ParseLib(), SetFileFormatVersionAtLoad(), SCH_IO_LIB_CACHE::SetParseError(), THROW_IO_ERROR, traceSchLegacyPlugin, updateParentSymbolLinks(), and IO_ERROR::What().

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

◆ 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_KICAD_SEXPR_LIB_CACHE::Save ( const std::optional< bool > & aOpt = std::nullopt)
overridevirtual

Save the entire library to file m_libFileName;.

Reimplemented from SCH_IO_LIB_CACHE.

Definition at line 209 of file sch_io_kicad_sexpr_lib_cache.cpp.

References _, CTX_FILENAME, EscapeString(), formatLibraryHeader(), LIB_SYMBOL::GetInheritanceDepth(), SCH_IO_LIB_CACHE::GetLibModificationTime(), LIB_SYMBOL::GetName(), SCH_IO_LIB_CACHE::GetRealFile(), SCH_IO_LIB_CACHE::HasParseError(), FILEEXT::KiCadSymbolLibFileExtension, SCH_IO_LIB_CACHE::m_fileModTime, SCH_IO_LIB_CACHE::m_isModified, SCH_IO_LIB_CACHE::m_libFileName, SCH_IO_LIB_CACHE::m_symbols, SCH_IO_LIB_CACHE::m_symbolSourceFiles, name, SaveSymbol(), and THROW_IO_ERROR.

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

◆ saveDcmInfoAsFields()

void SCH_IO_KICAD_SEXPR_LIB_CACHE::saveDcmInfoAsFields ( LIB_SYMBOL * aSymbol,
OUTPUTFORMATTER & aFormatter )
staticprivate

Definition at line 541 of file sch_io_kicad_sexpr_lib_cache.cpp.

References CTX_NO_SPACE, EscapeString(), filter, LIB_SYMBOL::GetFPFilters(), LIB_SYMBOL::GetKeyWords(), saveField(), SCH_FIELD::SetText(), EDA_TEXT::SetVisible(), and USER.

Referenced by SaveSymbol().

◆ saveField()

void SCH_IO_KICAD_SEXPR_LIB_CACHE::saveField ( SCH_FIELD * aField,
OUTPUTFORMATTER & aFormatter )
staticprivate

Definition at line 640 of file sch_io_kicad_sexpr_lib_cache.cpp.

References EDA_ANGLE::AsDegrees(), SCH_FIELD::CanAutoplace(), EDA_TEXT::Format(), KICAD_FORMAT::FormatBool(), EDA_UNIT_UTILS::FormatInternalUnits(), GetCanonicalFieldName(), SCH_FIELD::GetId(), SCH_FIELD::GetName(), SCH_FIELD::GetPosition(), SCH_FIELD::GetText(), EDA_TEXT::GetTextAngle(), SCH_FIELD::IsMandatory(), SCH_FIELD::IsNameShown(), SCH_ITEM::IsPrivate(), EDA_TEXT::IsVisible(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), SCH_FIELD_T, schIUScale, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by saveDcmInfoAsFields(), and SaveSymbol().

◆ savePin()

void SCH_IO_KICAD_SEXPR_LIB_CACHE::savePin ( SCH_PIN * aPin,
OUTPUTFORMATTER & aFormatter )
staticprivate

Definition at line 671 of file sch_io_kicad_sexpr_lib_cache.cpp.

References EDA_ITEM::ClearFlags(), EDA_UNIT_UTILS::FormatAngle(), KICAD_FORMAT::FormatBool(), EDA_UNIT_UTILS::FormatInternalUnits(), SCH_PIN::GetAlternates(), SCH_PIN::GetLength(), SCH_PIN::GetName(), SCH_PIN::GetNameTextSize(), SCH_PIN::GetNumber(), SCH_PIN::GetNumberTextSize(), SCH_PIN::GetOrientation(), getPinAngle(), getPinElectricalTypeToken(), getPinShapeToken(), SCH_PIN::GetPosition(), SCH_PIN::GetShape(), SCH_PIN::GetType(), IS_CHANGED, SCH_PIN::IsVisible(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), SCH_PIN_T, schIUScale, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by saveSymbolDrawItem().

◆ SaveSymbol()

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

Definition at line 336 of file sch_io_kicad_sexpr_lib_cache.cpp.

References EMBEDDED_FILES::ClearEmbeddedFonts(), DEFAULT_PIN_NAME_OFFSET, EMBEDDED_FILES::EmbeddedFileMap(), LIB_SYMBOL::EmbedFonts(), KICAD_FORMAT::FormatBool(), EDA_UNIT_UTILS::FormatInternalUnits(), EMBEDDED_FILES::GetAreFontsEmbedded(), LIB_SYMBOL::GetBodyStyleNames(), LIB_SYMBOL::GetDuplicatePinNumbersAreJumpers(), LIB_SYMBOL::GetEmbeddedFiles(), SYMBOL::GetExcludedFromBoard(), SYMBOL::GetExcludedFromBOM(), SYMBOL::GetExcludedFromPosFiles(), SYMBOL::GetExcludedFromSim(), LIB_SYMBOL::GetFields(), LIB_SYMBOL::GetLibId(), LIB_ID::GetLibItemName(), LIB_SYMBOL::GetParent(), SYMBOL::GetPinNameOffset(), SYMBOL::GetShowPinNames(), SYMBOL::GetShowPinNumbers(), LIB_SYMBOL::GetUnitDisplayNames(), LIB_SYMBOL::GetUnitDrawItems(), group, LIB_SYMBOL::HasDeMorganBodyStyles(), LIB_SYMBOL::IsGlobalPower(), LIB_SYMBOL::IsLocalPower(), LIB_SYMBOL::IsMultiBodyStyle(), LIB_SYMBOL::IsRoot(), LIB_SYMBOL::JumperPinGroups(), locked, name, LIB_ID::Parse(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotes(), OUTPUTFORMATTER::Quotew(), saveDcmInfoAsFields(), saveField(), saveSymbolDrawItem(), schIUScale, LIB_SYMBOL::UnitsLocked(), USER, EMBEDDED_FILES::WriteEmbeddedFiles(), and UTF8::wx_str().

Referenced by SCH_IO_KICAD_SEXPR::Format(), SCH_IO_KICAD_SEXPR::Format(), SCH_IO_KICAD_SEXPR::FormatLibSymbol(), and Save().

◆ saveSymbolDrawItem()

void SCH_IO_KICAD_SEXPR_LIB_CACHE::saveSymbolDrawItem ( SCH_ITEM * aItem,
OUTPUTFORMATTER & aFormatter )
staticprivate

Definition at line 579 of file sch_io_kicad_sexpr_lib_cache.cpp.

References ARC, BEZIER, CIRCLE, formatArc(), formatBezier(), formatCircle(), formatPoly(), formatRect(), SCH_ITEM::GetClass(), EDA_SHAPE::GetFillColor(), EDA_SHAPE::GetFillMode(), EDA_SHAPE::GetShape(), SCH_SHAPE::GetStroke(), SCH_ITEM::IsPrivate(), POLY, RECTANGLE, savePin(), saveText(), saveTextBox(), SCH_PIN_T, SCH_SHAPE_T, SCH_TEXT_T, SCH_TEXTBOX_T, EDA_SHAPE::SHAPE_T_asString(), EDA_ITEM::Type(), and UNIMPLEMENTED_FOR.

Referenced by SaveSymbol().

◆ saveText()

void SCH_IO_KICAD_SEXPR_LIB_CACHE::saveText ( SCH_TEXT * aText,
OUTPUTFORMATTER & aFormatter )
staticprivate

Definition at line 725 of file sch_io_kicad_sexpr_lib_cache.cpp.

References EDA_ANGLE::AsTenthsOfADegree(), EDA_UNIT_UTILS::FormatInternalUnits(), SCH_TEXT::GetPosition(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), SCH_ITEM::IsPrivate(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), SCH_TEXT_T, schIUScale, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by saveSymbolDrawItem().

◆ saveTextBox()

void SCH_IO_KICAD_SEXPR_LIB_CACHE::saveTextBox ( SCH_TEXTBOX * aTextBox,
OUTPUTFORMATTER & aFormatter )
staticprivate

Definition at line 743 of file sch_io_kicad_sexpr_lib_cache.cpp.

References STROKE_PARAMS::Format(), EDA_UNIT_UTILS::FormatAngle(), formatFill(), EDA_UNIT_UTILS::FormatInternalUnits(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetFillColor(), EDA_SHAPE::GetFillMode(), SCH_TEXTBOX::GetMarginBottom(), SCH_TEXTBOX::GetMarginLeft(), SCH_TEXTBOX::GetMarginRight(), SCH_TEXTBOX::GetMarginTop(), EDA_SHAPE::GetStart(), SCH_SHAPE::GetStroke(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), SCH_ITEM::IsPrivate(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), SCH_TEXTBOX_T, schIUScale, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by saveSymbolDrawItem().

◆ 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)
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
aHasErrortrue 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().

◆ updateParentSymbolLinks()

void SCH_IO_KICAD_SEXPR_LIB_CACHE::updateParentSymbolLinks ( )
private

Update the parent symbol links for derived symbols.

This is now performed post library load because the symbol load order cannot be controlled when the symbol library is saved as a single symbol per file in a folder.

Exceptions
IO_ERRORif a parent symbol name cannot be found for any symbols in the library.

Definition at line 819 of file sch_io_kicad_sexpr_lib_cache.cpp.

References _, SCH_IO_LIB_CACHE::m_libFileName, SCH_IO_LIB_CACHE::m_symbols, name, and THROW_IO_ERROR.

Referenced by Load().

Member Data Documentation

◆ m_fileFormatVersionAtLoad

int SCH_IO_KICAD_SEXPR_LIB_CACHE::m_fileFormatVersionAtLoad
private

Definition at line 77 of file sch_io_kicad_sexpr_lib_cache.h.

Referenced by GetFileFormatVersionAtLoad(), SCH_IO_KICAD_SEXPR_LIB_CACHE(), and SetFileFormatVersionAtLoad().

◆ 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_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: