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_LEGACY_PLUGIN_CACHE Class Reference

A cache assistant for KiCad legacy symbol libraries. More...

#include <sch_legacy_lib_plugin_cache.h>

Inheritance diagram for SCH_LEGACY_PLUGIN_CACHE:
SCH_LIB_PLUGIN_CACHE

Public Member Functions

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

Static Public Member Functions

static LIB_SYMBOL * LoadPart (LINE_READER &aReader, int aMajorVersion, int aMinorVersion, LIB_SYMBOL_MAP *aMap=nullptr)
 
static void SaveSymbol (LIB_SYMBOL *aSymbol, OUTPUTFORMATTER &aFormatter, LIB_SYMBOL_MAP *aMap=nullptr)
 

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
 

Private Member Functions

void loadHeader (FILE_LINE_READER &aReader)
 
void loadDocs ()
 
void saveDocFile ()
 

Static Private Member Functions

static void loadAliases (std::unique_ptr< LIB_SYMBOL > &aSymbol, LINE_READER &aReader, LIB_SYMBOL_MAP *aMap=nullptr)
 
static void loadField (std::unique_ptr< LIB_SYMBOL > &aSymbol, LINE_READER &aReader)
 
static void loadDrawEntries (std::unique_ptr< LIB_SYMBOL > &aSymbol, LINE_READER &aReader, int aMajorVersion, int aMinorVersion)
 
static void loadFootprintFilters (std::unique_ptr< LIB_SYMBOL > &aSymbol, LINE_READER &aReader)
 
static LIB_SHAPE * loadArc (std::unique_ptr< LIB_SYMBOL > &aSymbol, LINE_READER &aReader)
 
static LIB_SHAPE * loadCircle (std::unique_ptr< LIB_SYMBOL > &aSymbol, LINE_READER &aReader)
 
static LIB_TEXT * loadText (std::unique_ptr< LIB_SYMBOL > &aSymbol, LINE_READER &aReader, int aMajorVersion, int aMinorVersion)
 
static LIB_SHAPE * loadRect (std::unique_ptr< LIB_SYMBOL > &aSymbol, LINE_READER &aReader)
 
static LIB_PIN * loadPin (std::unique_ptr< LIB_SYMBOL > &aSymbol, LINE_READER &aReader)
 
static LIB_SHAPE * loadPolyLine (std::unique_ptr< LIB_SYMBOL > &aSymbol, LINE_READER &aReader)
 
static LIB_SHAPE * loadBezier (std::unique_ptr< LIB_SYMBOL > &aSymbol, LINE_READER &aReader)
 
static FILL_T parseFillMode (LINE_READER &aReader, const char *aLine, const char **aOutput)
 
static void saveArc (LIB_SHAPE *aArc, OUTPUTFORMATTER &aFormatter)
 
static void saveBezier (LIB_SHAPE *aBezier, OUTPUTFORMATTER &aFormatter)
 
static void saveCircle (LIB_SHAPE *aCircle, OUTPUTFORMATTER &aFormatter)
 
static void saveField (const LIB_FIELD *aField, OUTPUTFORMATTER &aFormatter)
 
static void savePin (const LIB_PIN *aPin, OUTPUTFORMATTER &aFormatter)
 
static void savePolyLine (LIB_SHAPE *aPolyLine, OUTPUTFORMATTER &aFormatter)
 
static void saveRectangle (LIB_SHAPE *aRectangle, OUTPUTFORMATTER &aFormatter)
 
static void saveText (const LIB_TEXT *aText, OUTPUTFORMATTER &aFormatter)
 

Private Attributes

friend SCH_LEGACY_PLUGIN
 
int m_versionMajor
 
int m_versionMinor
 

Detailed Description

A cache assistant for KiCad legacy symbol libraries.

Definition at line 43 of file sch_legacy_lib_plugin_cache.h.

Constructor & Destructor Documentation

◆ SCH_LEGACY_PLUGIN_CACHE()

SCH_LEGACY_PLUGIN_CACHE::SCH_LEGACY_PLUGIN_CACHE ( const wxString &  aLibraryPath)

Definition at line 59 of file sch_legacy_lib_plugin_cache.cpp.

References m_versionMajor, and m_versionMinor.

◆ ~SCH_LEGACY_PLUGIN_CACHE()

virtual SCH_LEGACY_PLUGIN_CACHE::~SCH_LEGACY_PLUGIN_CACHE ( )
inlinevirtual

Definition at line 47 of file sch_legacy_lib_plugin_cache.h.

Member Function Documentation

◆ AddSymbol()

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

Definition at line 161 of file sch_lib_plugin_cache.cpp.

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

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

◆ DeleteSymbol()

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

Implements SCH_LIB_PLUGIN_CACHE.

Definition at line 1816 of file sch_legacy_lib_plugin_cache.cpp.

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

Referenced by SCH_LEGACY_PLUGIN::DeleteSymbol().

◆ GetFileName()

wxString SCH_LIB_PLUGIN_CACHE::GetFileName ( ) const
inlineinherited

Definition at line 88 of file sch_lib_plugin_cache.h.

References SCH_LIB_PLUGIN_CACHE::m_libFileName.

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

◆ GetLibModificationTime()

wxDateTime SCH_LIB_PLUGIN_CACHE::GetLibModificationTime ( )
inherited

Definition at line 65 of file sch_lib_plugin_cache.cpp.

References SCH_LIB_PLUGIN_CACHE::GetRealFile(), and SCH_LIB_PLUGIN_CACHE::m_isWritable.

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

◆ GetLogicalName()

wxString SCH_LIB_PLUGIN_CACHE::GetLogicalName ( ) const
inlineinherited

Definition at line 84 of file sch_lib_plugin_cache.h.

References SCH_LIB_PLUGIN_CACHE::m_libFileName.

◆ GetModifyHash()

int SCH_LIB_PLUGIN_CACHE::GetModifyHash ( )
inlineinherited

Definition at line 52 of file sch_lib_plugin_cache.h.

References SCH_LIB_PLUGIN_CACHE::m_modHash, and SCH_LIB_PLUGIN_CACHE::m_modHashMutex.

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

◆ GetRealFile()

wxFileName SCH_LIB_PLUGIN_CACHE::GetRealFile ( ) const
inherited

Definition at line 55 of file sch_lib_plugin_cache.cpp.

References SCH_LIB_PLUGIN_CACHE::m_libFileName, and WX_FILENAME::ResolvePossibleSymlinks().

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

◆ GetSymbol()

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

Definition at line 178 of file sch_lib_plugin_cache.cpp.

References SCH_LIB_PLUGIN_CACHE::m_symbols.

Referenced by EESCHEMA_JOBS_HANDLER::JobSymExportSvg().

◆ GetSymbolMap()

const LIB_SYMBOL_MAP & SCH_LIB_PLUGIN_CACHE::GetSymbolMap ( ) const
inlineinherited

Definition at line 90 of file sch_lib_plugin_cache.h.

References SCH_LIB_PLUGIN_CACHE::m_symbols.

Referenced by EESCHEMA_JOBS_HANDLER::JobSymExportSvg().

◆ IncrementModifyHash()

void SCH_LIB_PLUGIN_CACHE::IncrementModifyHash ( )
inlineinherited

Definition at line 46 of file sch_lib_plugin_cache.h.

References SCH_LIB_PLUGIN_CACHE::m_modHash, and SCH_LIB_PLUGIN_CACHE::m_modHashMutex.

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

◆ IsFile()

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

Definition at line 77 of file sch_lib_plugin_cache.cpp.

References SCH_LIB_PLUGIN_CACHE::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
inherited

Definition at line 83 of file sch_lib_plugin_cache.cpp.

References SCH_LIB_PLUGIN_CACHE::GetRealFile(), and SCH_LIB_PLUGIN_CACHE::m_fileModTime.

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

◆ Load()

void SCH_LEGACY_PLUGIN_CACHE::Load ( )
overridevirtual
Todo:
Probably should check for a valid date and time stamp even though it's not used.

Implements SCH_LIB_PLUGIN_CACHE.

Definition at line 67 of file sch_legacy_lib_plugin_cache.cpp.

References _, SCH_LIB_PLUGIN_CACHE::GetLibModificationTime(), LIB_SYMBOL::GetName(), SCH_LIB_PLUGIN_CACHE::IncrementModifyHash(), LINE_READER::Line(), loadDocs(), loadHeader(), LoadPart(), SCH_LIB_PLUGIN_CACHE::m_fileModTime, SCH_LIB_PLUGIN_CACHE::m_libFileName, SCH_LIB_PLUGIN_CACHE::m_libType, SCH_LIB_PLUGIN_CACHE::m_symbols, m_versionMajor, m_versionMinor, parseInt(), FILE_LINE_READER::ReadLine(), SCH_PARSE_ERROR, strCompare(), THROW_IO_ERROR, traceSchLegacyPlugin, and USE_OLD_DOC_FILE_FORMAT.

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

◆ loadAliases()

void SCH_LEGACY_PLUGIN_CACHE::loadAliases ( std::unique_ptr< LIB_SYMBOL > &  aSymbol,
LINE_READER &  aReader,
LIB_SYMBOL_MAP *  aMap = nullptr 
)
staticprivate

Definition at line 466 of file sch_legacy_lib_plugin_cache.cpp.

References LIB_SYMBOL::GetFieldById(), LIB_SYMBOL::GetName(), LINE_READER::Line(), MANDATORY_FIELDS, EDA_ITEM::SetParent(), LIB_SYMBOL::SetParent(), EDA_TEXT::SetText(), strCompare(), and VALUE_FIELD.

Referenced by LoadPart().

◆ loadArc()

LIB_SHAPE * SCH_LEGACY_PLUGIN_CACHE::loadArc ( std::unique_ptr< LIB_SYMBOL > &  aSymbol,
LINE_READER &  aReader 
)
staticprivate

Definition at line 749 of file sch_legacy_lib_plugin_cache.cpp.

References ANGLE_180, CalcArcCenter(), DEGREES_T, EDA_SHAPE::GetArcAngle(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), LINE_READER::Line(), EDA_IU_SCALE::MilsToIU(), parseFillMode(), parseInt(), schIUScale, EDA_SHAPE::SetArcAngleAndEnd(), EDA_SHAPE::SetCenter(), LIB_ITEM::SetConvert(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFillMode(), LIB_SHAPE::SetPosition(), EDA_SHAPE::SetStart(), LIB_SHAPE::SetStroke(), LIB_ITEM::SetUnit(), strCompare(), TENTHS_OF_A_DEGREE_T, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by loadDrawEntries().

◆ loadBezier()

LIB_SHAPE * SCH_LEGACY_PLUGIN_CACHE::loadBezier ( std::unique_ptr< LIB_SYMBOL > &  aSymbol,
LINE_READER &  aReader 
)
staticprivate

Definition at line 1255 of file sch_legacy_lib_plugin_cache.cpp.

References EDA_SHAPE::GetWidth(), LINE_READER::Line(), EDA_IU_SCALE::MilsToIU(), parseFillMode(), parseInt(), EDA_SHAPE::RebuildBezierToSegmentsPointsList(), schIUScale, EDA_SHAPE::SetBezierC1(), EDA_SHAPE::SetBezierC2(), LIB_ITEM::SetConvert(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFillMode(), EDA_SHAPE::SetStart(), LIB_SHAPE::SetStroke(), LIB_ITEM::SetUnit(), strCompare(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by loadDrawEntries().

◆ loadCircle()

LIB_SHAPE * SCH_LEGACY_PLUGIN_CACHE::loadCircle ( std::unique_ptr< LIB_SYMBOL > &  aSymbol,
LINE_READER &  aReader 
)
staticprivate

Definition at line 833 of file sch_legacy_lib_plugin_cache.cpp.

References LINE_READER::Line(), EDA_IU_SCALE::MilsToIU(), parseFillMode(), parseInt(), schIUScale, LIB_ITEM::SetConvert(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFillMode(), EDA_SHAPE::SetStart(), LIB_SHAPE::SetStroke(), LIB_ITEM::SetUnit(), strCompare(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by loadDrawEntries().

◆ loadDocs()

void SCH_LEGACY_PLUGIN_CACHE::loadDocs ( )
private

Definition at line 155 of file sch_legacy_lib_plugin_cache.cpp.

References _, DATASHEET_FIELD, DOCFILE_IDENT, From_UTF8(), LIB_SYMBOL::GetFieldById(), LegacySymbolDocumentFileExtension, LINE_READER::Line(), LINE_READER::LineNumber(), SCH_LIB_PLUGIN_CACHE::m_libFileName, SCH_LIB_PLUGIN_CACHE::m_symbols, FILE_LINE_READER::ReadLine(), SCH_PARSE_ERROR, LIB_SYMBOL::SetDescription(), LIB_SYMBOL::SetKeyWords(), EDA_TEXT::SetText(), strCompare(), text, and THROW_IO_ERROR.

Referenced by Load().

◆ loadDrawEntries()

void SCH_LEGACY_PLUGIN_CACHE::loadDrawEntries ( std::unique_ptr< LIB_SYMBOL > &  aSymbol,
LINE_READER &  aReader,
int  aMajorVersion,
int  aMinorVersion 
)
staticprivate

Definition at line 667 of file sch_legacy_lib_plugin_cache.cpp.

References LINE_READER::Line(), loadArc(), loadBezier(), loadCircle(), loadPin(), loadPolyLine(), loadRect(), loadText(), LINE_READER::ReadLine(), SCH_PARSE_ERROR, and strCompare().

Referenced by LoadPart().

◆ loadField()

void SCH_LEGACY_PLUGIN_CACHE::loadField ( std::unique_ptr< LIB_SYMBOL > &  aSymbol,
LINE_READER &  aReader 
)
staticprivate

Definition at line 516 of file sch_legacy_lib_plugin_cache.cpp.

References _, ANGLE_HORIZONTAL, ANGLE_VERTICAL, ConvertToNewOverbarNotation(), CTX_QUOTED_STR, EscapeString(), TEMPLATE_FIELDNAME::GetDefaultFieldName(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, LINE_READER::Line(), LIB_FIELD::m_name, MANDATORY_FIELDS, EDA_IU_SCALE::MilsToIU(), parseChar(), parseInt(), parseQuotedString(), parseUnquotedString(), SCH_PARSE_ERROR, schIUScale, EDA_TEXT::SetBold(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), LIB_ITEM::SetPosition(), EDA_TEXT::SetText(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetVertJustify(), EDA_TEXT::SetVisible(), text, VALUE_FIELD, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by LoadPart().

◆ loadFootprintFilters()

void SCH_LEGACY_PLUGIN_CACHE::loadFootprintFilters ( std::unique_ptr< LIB_SYMBOL > &  aSymbol,
LINE_READER &  aReader 
)
staticprivate

Definition at line 1302 of file sch_legacy_lib_plugin_cache.cpp.

References LINE_READER::Line(), parseUnquotedString(), LINE_READER::ReadLine(), SCH_PARSE_ERROR, and strCompare().

Referenced by LoadPart().

◆ loadHeader()

void SCH_LEGACY_PLUGIN_CACHE::loadHeader ( FILE_LINE_READER &  aReader)
private

Definition at line 259 of file sch_legacy_lib_plugin_cache.cpp.

References LINE_READER::Line(), FILE_LINE_READER::ReadLine(), SCH_PARSE_ERROR, and strCompare().

Referenced by Load().

◆ LoadPart()

LIB_SYMBOL * SCH_LEGACY_PLUGIN_CACHE::LoadPart ( LINE_READER &  aReader,
int  aMajorVersion,
int  aMinorVersion,
LIB_SYMBOL_MAP *  aMap = nullptr 
)
static

Definition at line 281 of file sch_legacy_lib_plugin_cache.cpp.

References EDA_TEXT::Empty(), LINE_READER::GetSource(), LIB_VERSION, LINE_READER::Line(), LINE_READER::LineNumber(), loadAliases(), loadDrawEntries(), loadField(), loadFootprintFilters(), EDA_IU_SCALE::MilsToIU(), name, LINE_READER::ReadLine(), SCH_PARSE_ERROR, schIUScale, EDA_TEXT::SetText(), EDA_TEXT::SetVisible(), strCompare(), THROW_PARSE_ERROR, and UnescapeString().

Referenced by Load(), and SCH_LEGACY_PLUGIN::ParsePart().

◆ loadPin()

LIB_PIN * SCH_LEGACY_PLUGIN_CACHE::loadPin ( std::unique_ptr< LIB_SYMBOL > &  aSymbol,
LINE_READER &  aReader 
)
staticprivate

Definition at line 1000 of file sch_legacy_lib_plugin_cache.cpp.

References convert, ConvertToNewOverbarNotation(), LINE_READER::GetSource(), INVERTED, LINE_READER::Line(), LINE_READER::LineNumber(), EDA_IU_SCALE::MilsToIU(), name, NONLOGIC, pin, SCH_PARSE_ERROR, schIUScale, strCompare(), THROW_PARSE_ERROR, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by loadDrawEntries().

◆ loadPolyLine()

LIB_SHAPE * SCH_LEGACY_PLUGIN_CACHE::loadPolyLine ( std::unique_ptr< LIB_SYMBOL > &  aSymbol,
LINE_READER &  aReader 
)
staticprivate

Definition at line 1222 of file sch_legacy_lib_plugin_cache.cpp.

References LIB_SHAPE::AddPoint(), LINE_READER::Line(), EDA_IU_SCALE::MilsToIU(), parseFillMode(), parseInt(), schIUScale, LIB_ITEM::SetConvert(), EDA_SHAPE::SetFillMode(), LIB_SHAPE::SetStroke(), LIB_ITEM::SetUnit(), strCompare(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by loadDrawEntries().

◆ loadRect()

LIB_SHAPE * SCH_LEGACY_PLUGIN_CACHE::loadRect ( std::unique_ptr< LIB_SYMBOL > &  aSymbol,
LINE_READER &  aReader 
)
staticprivate

Definition at line 964 of file sch_legacy_lib_plugin_cache.cpp.

References LINE_READER::Line(), EDA_IU_SCALE::MilsToIU(), parseFillMode(), parseInt(), schIUScale, LIB_ITEM::SetConvert(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFillMode(), LIB_SHAPE::SetPosition(), LIB_SHAPE::SetStroke(), LIB_ITEM::SetUnit(), strCompare(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by loadDrawEntries().

◆ loadText()

LIB_TEXT * SCH_LEGACY_PLUGIN_CACHE::loadText ( std::unique_ptr< LIB_SYMBOL > &  aSymbol,
LINE_READER &  aReader,
int  aMajorVersion,
int  aMinorVersion 
)
staticprivate

Definition at line 865 of file sch_legacy_lib_plugin_cache.cpp.

References ConvertToNewOverbarNotation(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, is_eol(), LIB_VERSION, LINE_READER::Line(), EDA_IU_SCALE::MilsToIU(), parseChar(), parseInt(), parseQuotedString(), parseUnquotedString(), SCH_PARSE_ERROR, schIUScale, strCompare(), TENTHS_OF_A_DEGREE_T, text, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by loadDrawEntries().

◆ parseFillMode()

FILL_T SCH_LEGACY_PLUGIN_CACHE::parseFillMode ( LINE_READER &  aReader,
const char *  aLine,
const char **  aOutput 
)
staticprivate

Definition at line 734 of file sch_legacy_lib_plugin_cache.cpp.

References parseChar(), and SCH_PARSE_ERROR.

Referenced by loadArc(), loadBezier(), loadCircle(), loadPolyLine(), and loadRect().

◆ removeSymbol()

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

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(), SCH_LIB_PLUGIN_CACHE::IncrementModifyHash(), LIB_SYMBOL::IsRoot(), LIB_FIELD_T, SCH_LIB_PLUGIN_CACHE::m_isModified, SCH_LIB_PLUGIN_CACHE::m_libFileName, SCH_LIB_PLUGIN_CACHE::m_symbols, EDA_ITEM::SetParent(), and LIB_SYMBOL::SharedPtr().

Referenced by SCH_LIB_PLUGIN_CACHE::AddSymbol().

◆ Save()

void SCH_LEGACY_PLUGIN_CACHE::Save ( const std::optional< bool > &  aOpt)
overridevirtual

Save the entire library to file m_libFileName;.

Reimplemented from SCH_LIB_PLUGIN_CACHE.

Definition at line 1332 of file sch_legacy_lib_plugin_cache.cpp.

References SCH_LIB_PLUGIN_CACHE::GetRealFile(), LIB_VERSION_MAJOR, LIB_VERSION_MINOR, LIBFILE_IDENT, SCH_LIB_PLUGIN_CACHE::m_fileModTime, SCH_LIB_PLUGIN_CACHE::m_isModified, SCH_LIB_PLUGIN_CACHE::m_symbols, saveDocFile(), and SaveSymbol().

Referenced by SCH_LEGACY_PLUGIN::CreateSymbolLib(), SCH_LEGACY_PLUGIN::DeleteSymbol(), SCH_LEGACY_PLUGIN::SaveLibrary(), and SCH_LEGACY_PLUGIN::SaveSymbol().

◆ saveArc()

void SCH_LEGACY_PLUGIN_CACHE::saveArc ( LIB_SHAPE *  aArc,
OUTPUTFORMATTER &  aFormatter 
)
staticprivate

Definition at line 1520 of file sch_legacy_lib_plugin_cache.cpp.

References EDA_ANGLE::AsTenthsOfADegree(), EDA_SHAPE::CalcArcAngles(), fill_tab, LIB_ITEM::GetConvert(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetFillMode(), LIB_SHAPE::GetPosition(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), LIB_ITEM::GetUnit(), EDA_SHAPE::GetWidth(), EDA_IU_SCALE::IUToMils(), EDA_ANGLE::Normalize180(), OUTPUTFORMATTER::Print(), schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SaveSymbol().

◆ saveBezier()

void SCH_LEGACY_PLUGIN_CACHE::saveBezier ( LIB_SHAPE *  aBezier,
OUTPUTFORMATTER &  aFormatter 
)
staticprivate

Definition at line 1547 of file sch_legacy_lib_plugin_cache.cpp.

References fill_tab, EDA_SHAPE::GetBezierC1(), EDA_SHAPE::GetBezierC2(), LIB_ITEM::GetConvert(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetFillMode(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), LIB_ITEM::GetUnit(), EDA_SHAPE::GetWidth(), EDA_IU_SCALE::IUToMils(), OUTPUTFORMATTER::Print(), schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SaveSymbol().

◆ saveCircle()

void SCH_LEGACY_PLUGIN_CACHE::saveCircle ( LIB_SHAPE *  aCircle,
OUTPUTFORMATTER &  aFormatter 
)
staticprivate

Definition at line 1570 of file sch_legacy_lib_plugin_cache.cpp.

References fill_tab, LIB_ITEM::GetConvert(), EDA_SHAPE::GetFillMode(), LIB_SHAPE::GetPosition(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), LIB_ITEM::GetUnit(), EDA_SHAPE::GetWidth(), EDA_IU_SCALE::IUToMils(), OUTPUTFORMATTER::Print(), schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SaveSymbol().

◆ saveDocFile()

void SCH_LEGACY_PLUGIN_CACHE::saveDocFile ( )
private

Definition at line 1774 of file sch_legacy_lib_plugin_cache.cpp.

References DOCFILE_IDENT, LegacySymbolDocumentFileExtension, SCH_LIB_PLUGIN_CACHE::m_libFileName, SCH_LIB_PLUGIN_CACHE::m_symbols, OUTPUTFORMATTER::Print(), and TO_UTF8.

Referenced by Save().

◆ saveField()

void SCH_LEGACY_PLUGIN_CACHE::saveField ( const LIB_FIELD *  aField,
OUTPUTFORMATTER &  aFormatter 
)
staticprivate

Definition at line 1585 of file sch_legacy_lib_plugin_cache.cpp.

References EscapedUTF8(), TEMPLATE_FIELDNAME::GetDefaultFieldName(), EDA_TEXT::GetHorizJustify(), LIB_FIELD::GetId(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextWidth(), EDA_TEXT::GetVertJustify(), GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_TOP, EDA_TEXT::IsBold(), EDA_ANGLE::IsHorizontal(), EDA_TEXT::IsItalic(), EDA_TEXT::IsVisible(), EDA_IU_SCALE::IUToMils(), LIB_FIELD_T, LIB_FIELD::m_name, MANDATORY_FIELDS, OUTPUTFORMATTER::Print(), schIUScale, text, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SaveSymbol().

◆ savePin()

void SCH_LEGACY_PLUGIN_CACHE::savePin ( const LIB_PIN *  aPin,
OUTPUTFORMATTER &  aFormatter 
)
staticprivate

Definition at line 1633 of file sch_legacy_lib_plugin_cache.cpp.

References LIB_ITEM::GetConvert(), LIB_PIN::GetLength(), LIB_PIN::GetName(), LIB_PIN::GetNameTextSize(), LIB_PIN::GetNumber(), LIB_PIN::GetNumberTextSize(), LIB_PIN::GetOrientation(), LIB_PIN::GetPosition(), LIB_PIN::GetShape(), LIB_PIN::GetType(), LIB_ITEM::GetUnit(), IS_CHANGED, LIB_PIN::IsVisible(), EDA_IU_SCALE::IUToMils(), LIB_PIN_T, OUTPUTFORMATTER::Print(), schIUScale, TO_UTF8, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SaveSymbol().

◆ savePolyLine()

void SCH_LEGACY_PLUGIN_CACHE::savePolyLine ( LIB_SHAPE *  aPolyLine,
OUTPUTFORMATTER &  aFormatter 
)
staticprivate

Definition at line 1698 of file sch_legacy_lib_plugin_cache.cpp.

References SHAPE_LINE_CHAIN::CPoints(), fill_tab, LIB_ITEM::GetConvert(), EDA_SHAPE::GetFillMode(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetShape(), LIB_ITEM::GetUnit(), EDA_SHAPE::GetWidth(), EDA_IU_SCALE::IUToMils(), SHAPE_POLY_SET::Outline(), OUTPUTFORMATTER::Print(), and schIUScale.

Referenced by SaveSymbol().

◆ saveRectangle()

void SCH_LEGACY_PLUGIN_CACHE::saveRectangle ( LIB_SHAPE *  aRectangle,
OUTPUTFORMATTER &  aFormatter 
)
staticprivate

Definition at line 1715 of file sch_legacy_lib_plugin_cache.cpp.

References fill_tab, LIB_ITEM::GetConvert(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetFillMode(), LIB_SHAPE::GetPosition(), EDA_SHAPE::GetShape(), LIB_ITEM::GetUnit(), EDA_SHAPE::GetWidth(), EDA_IU_SCALE::IUToMils(), OUTPUTFORMATTER::Print(), schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SaveSymbol().

◆ SaveSymbol()

void SCH_LEGACY_PLUGIN_CACHE::SaveSymbol ( LIB_SYMBOL *  aSymbol,
OUTPUTFORMATTER &  aFormatter,
LIB_SYMBOL_MAP *  aMap = nullptr 
)
static

Definition at line 1367 of file sch_legacy_lib_plugin_cache.cpp.

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::empty(), LIB_SYMBOL::GetDrawItems(), LIB_SYMBOL::GetFields(), LIB_SYMBOL::GetFPFilters(), LIB_SYMBOL::GetLastModDate(), LIB_SYMBOL::GetName(), LIB_SYMBOL::GetParent(), LIB_SYMBOL::GetPinNameOffset(), LIB_SYMBOL::GetReferenceField(), EDA_SHAPE::GetShape(), EDA_TEXT::GetText(), LIB_SYMBOL::GetUnitCount(), LIB_SYMBOL::GetValueField(), LIB_SYMBOL::IsAlias(), LIB_SYMBOL::IsPower(), LIB_SYMBOL::IsRoot(), EDA_IU_SCALE::IUToMils(), LIB_FIELD_T, LIB_PIN_T, LIB_SHAPE_T, LIB_TEXT_T, MANDATORY_FIELDS, OUTPUTFORMATTER::Print(), saveArc(), saveBezier(), saveCircle(), saveField(), savePin(), savePolyLine(), saveRectangle(), saveText(), schIUScale, LIB_SYMBOL::SharedPtr(), LIB_SYMBOL::ShowPinNames(), LIB_SYMBOL::ShowPinNumbers(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::sort(), TO_UTF8, and LIB_SYMBOL::UnitsLocked().

Referenced by SCH_LEGACY_PLUGIN::FormatPart(), and Save().

◆ saveText()

void SCH_LEGACY_PLUGIN_CACHE::saveText ( const LIB_TEXT *  aText,
OUTPUTFORMATTER &  aFormatter 
)
staticprivate

Definition at line 1731 of file sch_legacy_lib_plugin_cache.cpp.

References EDA_ANGLE::AsTenthsOfADegree(), LIB_ITEM::GetConvert(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextWidth(), LIB_ITEM::GetUnit(), EDA_TEXT::GetVertJustify(), GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_TOP, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsVisible(), EDA_IU_SCALE::IUToMils(), LIB_TEXT_T, OUTPUTFORMATTER::Print(), schIUScale, text, TO_UTF8, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SaveSymbol().

◆ SetFileName()

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

Definition at line 86 of file sch_lib_plugin_cache.h.

References SCH_LIB_PLUGIN_CACHE::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)
inlineinherited

Definition at line 82 of file sch_lib_plugin_cache.h.

References SCH_LIB_PLUGIN_CACHE::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
protectedinherited

Definition at line 100 of file sch_lib_plugin_cache.h.

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

◆ m_fileName

wxString SCH_LIB_PLUGIN_CACHE::m_fileName
protectedinherited

Definition at line 98 of file sch_lib_plugin_cache.h.

Referenced by SCH_LIB_PLUGIN_CACHE::IsFile().

◆ m_isModified

bool SCH_LIB_PLUGIN_CACHE::m_isModified
protectedinherited

Definition at line 103 of file sch_lib_plugin_cache.h.

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

◆ m_isWritable

bool SCH_LIB_PLUGIN_CACHE::m_isWritable
protectedinherited

Definition at line 102 of file sch_lib_plugin_cache.h.

Referenced by SCH_LIB_PLUGIN_CACHE::GetLibModificationTime().

◆ m_libFileName

wxFileName SCH_LIB_PLUGIN_CACHE::m_libFileName
protectedinherited

Definition at line 99 of file sch_lib_plugin_cache.h.

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

◆ m_libType

SCH_LIB_TYPE SCH_LIB_PLUGIN_CACHE::m_libType
protectedinherited

Definition at line 104 of file sch_lib_plugin_cache.h.

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

◆ m_modHash

int SCH_LIB_PLUGIN_CACHE::m_modHash
protectedinherited

Definition at line 95 of file sch_lib_plugin_cache.h.

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

◆ m_modHashMutex

std::mutex SCH_LIB_PLUGIN_CACHE::m_modHashMutex
protectedinherited

Definition at line 96 of file sch_lib_plugin_cache.h.

Referenced by SCH_LIB_PLUGIN_CACHE::GetModifyHash(), and SCH_LIB_PLUGIN_CACHE::IncrementModifyHash().

◆ m_symbols

LIB_SYMBOL_MAP SCH_LIB_PLUGIN_CACHE::m_symbols
protectedinherited

Definition at line 101 of file sch_lib_plugin_cache.h.

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

◆ m_versionMajor

int SCH_LEGACY_PLUGIN_CACHE::m_versionMajor
private

Definition at line 98 of file sch_legacy_lib_plugin_cache.h.

Referenced by Load(), and SCH_LEGACY_PLUGIN_CACHE().

◆ m_versionMinor

int SCH_LEGACY_PLUGIN_CACHE::m_versionMinor
private

Definition at line 99 of file sch_legacy_lib_plugin_cache.h.

Referenced by Load(), and SCH_LEGACY_PLUGIN_CACHE().

◆ SCH_LEGACY_PLUGIN

friend SCH_LEGACY_PLUGIN_CACHE::SCH_LEGACY_PLUGIN
private

Definition at line 66 of file sch_legacy_lib_plugin_cache.h.

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