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

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

#include <sch_io_kicad_legacy_lib_cache.h>

Inheritance diagram for SCH_IO_KICAD_LEGACY_LIB_CACHE:
SCH_IO_LIB_CACHE

Public Member Functions

 SCH_IO_KICAD_LEGACY_LIB_CACHE (const wxString &aLibraryPath)
 
virtual ~SCH_IO_KICAD_LEGACY_LIB_CACHE ()
 
void Save (const std::optional< bool > &aOpt) override
 Save the entire library to file m_libFileName;.
 
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 SCH_SHAPE * loadArc (LINE_READER &aReader)
 
static SCH_SHAPE * loadCircle (LINE_READER &aReader)
 
static SCH_TEXT * loadText (LINE_READER &aReader, int aMajorVersion, int aMinorVersion)
 
static SCH_SHAPE * loadRect (LINE_READER &aReader)
 
static SCH_PIN * loadPin (std::unique_ptr< LIB_SYMBOL > &aSymbol, LINE_READER &aReader)
 
static SCH_SHAPE * loadPolyLine (LINE_READER &aReader)
 
static SCH_SHAPE * loadBezier (LINE_READER &aReader)
 
static FILL_T parseFillMode (LINE_READER &aReader, const char *aLine, const char **aOutput)
 
static void saveArc (SCH_SHAPE *aArc, OUTPUTFORMATTER &aFormatter)
 
static void saveBezier (SCH_SHAPE *aBezier, OUTPUTFORMATTER &aFormatter)
 
static void saveCircle (SCH_SHAPE *aCircle, OUTPUTFORMATTER &aFormatter)
 
static void saveField (const SCH_FIELD *aField, OUTPUTFORMATTER &aFormatter)
 
static void savePin (const SCH_PIN *aPin, OUTPUTFORMATTER &aFormatter)
 
static void savePolyLine (SCH_SHAPE *aPolyLine, OUTPUTFORMATTER &aFormatter)
 
static void saveRectangle (SCH_SHAPE *aRectangle, OUTPUTFORMATTER &aFormatter)
 
static void saveText (const SCH_TEXT *aText, OUTPUTFORMATTER &aFormatter)
 

Private Attributes

friend SCH_IO_KICAD_LEGACY
 
int m_versionMajor
 
int m_versionMinor
 

Detailed Description

A cache assistant for KiCad legacy symbol libraries.

Definition at line 43 of file sch_io_kicad_legacy_lib_cache.h.

Constructor & Destructor Documentation

◆ SCH_IO_KICAD_LEGACY_LIB_CACHE()

SCH_IO_KICAD_LEGACY_LIB_CACHE::SCH_IO_KICAD_LEGACY_LIB_CACHE ( const wxString &  aLibraryPath)

Definition at line 62 of file sch_io_kicad_legacy_lib_cache.cpp.

References m_versionMajor, and m_versionMinor.

◆ ~SCH_IO_KICAD_LEGACY_LIB_CACHE()

virtual SCH_IO_KICAD_LEGACY_LIB_CACHE::~SCH_IO_KICAD_LEGACY_LIB_CACHE ( )
inlinevirtual

Definition at line 47 of file sch_io_kicad_legacy_lib_cache.h.

Member Function Documentation

◆ AddSymbol()

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

Definition at line 161 of file sch_io_lib_cache.cpp.

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

Referenced by SCH_IO_KICAD_LEGACY::SaveSymbol(), and SCH_IO_KICAD_SEXPR::SaveSymbol().

◆ DeleteSymbol()

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

Implements SCH_IO_LIB_CACHE.

Definition at line 1912 of file sch_io_kicad_legacy_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.

Referenced by SCH_IO_KICAD_LEGACY::DeleteSymbol().

◆ GetFileName()

wxString SCH_IO_LIB_CACHE::GetFileName ( ) const
inlineinherited

Definition at line 88 of file sch_io_lib_cache.h.

References SCH_IO_LIB_CACHE::m_libFileName.

Referenced by SCH_IO_KICAD_LEGACY::SaveLibrary(), and SCH_IO_KICAD_SEXPR::SaveLibrary().

◆ GetLibModificationTime()

wxDateTime SCH_IO_LIB_CACHE::GetLibModificationTime ( )
inherited

Definition at line 65 of file sch_io_lib_cache.cpp.

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

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

◆ 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

Definition at line 52 of file sch_io_lib_cache.h.

References SCH_IO_LIB_CACHE::m_modHash, and SCH_IO_LIB_CACHE::m_modHashMutex.

Referenced by SCH_IO_KICAD_LEGACY::GetModifyHash(), and SCH_IO_KICAD_SEXPR::GetModifyHash().

◆ GetRealFile()

wxFileName SCH_IO_LIB_CACHE::GetRealFile ( ) const
inherited

Definition at line 55 of file sch_io_lib_cache.cpp.

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

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

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

void SCH_IO_LIB_CACHE::IncrementModifyHash ( )
inlineinherited

Definition at line 46 of file sch_io_lib_cache.h.

References SCH_IO_LIB_CACHE::m_modHash, and SCH_IO_LIB_CACHE::m_modHashMutex.

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

◆ IsFile()

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

Definition at line 77 of file sch_io_lib_cache.cpp.

References SCH_IO_LIB_CACHE::m_fileName.

Referenced by SCH_IO_KICAD_LEGACY::cacheLib(), SCH_IO_KICAD_SEXPR::cacheLib(), SCH_IO_KICAD_LEGACY::DeleteLibrary(), SCH_IO_KICAD_SEXPR::DeleteLibrary(), SCH_IO_KICAD_LEGACY::SaveLibrary(), and SCH_IO_KICAD_SEXPR::SaveLibrary().

◆ IsFileChanged()

bool SCH_IO_LIB_CACHE::IsFileChanged ( ) const
inherited

Definition at line 83 of file sch_io_lib_cache.cpp.

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

Referenced by SCH_IO_KICAD_LEGACY::cacheLib(), and SCH_IO_KICAD_SEXPR::cacheLib().

◆ Load()

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

Implements SCH_IO_LIB_CACHE.

Definition at line 70 of file sch_io_kicad_legacy_lib_cache.cpp.

References _, SCH_IO_LIB_CACHE::GetLibModificationTime(), LIB_SYMBOL::GetName(), SCH_IO_LIB_CACHE::IncrementModifyHash(), LINE_READER::Line(), loadDocs(), loadHeader(), LoadPart(), SCH_IO_LIB_CACHE::m_fileModTime, SCH_IO_LIB_CACHE::m_libFileName, SCH_IO_LIB_CACHE::m_libType, SCH_IO_LIB_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_IO_KICAD_LEGACY::cacheLib(), and SCH_IO_KICAD_LEGACY::CreateLibrary().

◆ loadAliases()

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

Definition at line 480 of file sch_io_kicad_legacy_lib_cache.cpp.

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

Referenced by LoadPart().

◆ loadArc()

SCH_SHAPE * SCH_IO_KICAD_LEGACY_LIB_CACHE::loadArc ( LINE_READER &  aReader)
staticprivate

This accounts for an oddity in the old library format, where the symbol is overdefined. The previous draw (based on wxwidgets) used start point and end point and always drew counter-clockwise. The new GAL draw takes center, radius and start/end angles. All of these points were stored in the file, so we need to mimic the swapping of start/end points rather than using the stored angles in order to properly map edge cases.

Definition at line 837 of file sch_io_kicad_legacy_lib_cache.cpp.

References SCH_SHAPE::GetCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), LAYER_DEVICE, LINE_READER::Line(), MapAnglesV6(), EDA_IU_SCALE::MilsToIU(), NORMALIZE_ANGLE_POS(), parseFillMode(), parseInt(), RotatePoint(), schIUScale, SCH_ITEM::SetBodyStyle(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFillMode(), SCH_SHAPE::SetPosition(), EDA_SHAPE::SetStart(), SCH_SHAPE::SetStroke(), SCH_ITEM::SetUnit(), strCompare(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by loadDrawEntries().

◆ loadBezier()

SCH_SHAPE * SCH_IO_KICAD_LEGACY_LIB_CACHE::loadBezier ( LINE_READER &  aReader)
staticprivate

Definition at line 1338 of file sch_io_kicad_legacy_lib_cache.cpp.

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

Referenced by loadDrawEntries().

◆ loadCircle()

SCH_SHAPE * SCH_IO_KICAD_LEGACY_LIB_CACHE::loadCircle ( LINE_READER &  aReader)
staticprivate

Definition at line 918 of file sch_io_kicad_legacy_lib_cache.cpp.

References LAYER_DEVICE, LINE_READER::Line(), EDA_IU_SCALE::MilsToIU(), parseFillMode(), parseInt(), schIUScale, SCH_ITEM::SetBodyStyle(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFillMode(), EDA_SHAPE::SetStart(), SCH_SHAPE::SetStroke(), SCH_ITEM::SetUnit(), strCompare(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by loadDrawEntries().

◆ loadDocs()

void SCH_IO_KICAD_LEGACY_LIB_CACHE::loadDocs ( )
private

Definition at line 169 of file sch_io_kicad_legacy_lib_cache.cpp.

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

Referenced by Load().

◆ loadDrawEntries()

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

Definition at line 694 of file sch_io_kicad_legacy_lib_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_IO_KICAD_LEGACY_LIB_CACHE::loadField ( std::unique_ptr< LIB_SYMBOL > &  aSymbol,
LINE_READER &  aReader 
)
staticprivate

Definition at line 530 of file sch_io_kicad_legacy_lib_cache.cpp.

References _, ANGLE_HORIZONTAL, ANGLE_VERTICAL, ConvertToNewOverbarNotation(), CTX_QUOTED_STR, EscapeString(), GetCanonicalFieldName(), 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(), MANDATORY_FIELDS, EDA_IU_SCALE::MilsToIU(), parseChar(), parseInt(), parseQuotedString(), parseUnquotedString(), SCH_PARSE_ERROR, schIUScale, EDA_TEXT::SetBoldFlag(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), SCH_FIELD::SetName(), SCH_FIELD::SetPosition(), SCH_FIELD::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_IO_KICAD_LEGACY_LIB_CACHE::loadFootprintFilters ( std::unique_ptr< LIB_SYMBOL > &  aSymbol,
LINE_READER &  aReader 
)
staticprivate

Definition at line 1385 of file sch_io_kicad_legacy_lib_cache.cpp.

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

Referenced by LoadPart().

◆ loadHeader()

void SCH_IO_KICAD_LEGACY_LIB_CACHE::loadHeader ( FILE_LINE_READER &  aReader)
private

Definition at line 273 of file sch_io_kicad_legacy_lib_cache.cpp.

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

Referenced by Load().

◆ LoadPart()

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

Definition at line 295 of file sch_io_kicad_legacy_lib_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, SCH_FIELD::SetText(), EDA_TEXT::SetVisible(), strCompare(), THROW_PARSE_ERROR, and UnescapeString().

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

◆ loadPin()

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

Definition at line 1084 of file sch_io_kicad_legacy_lib_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()

SCH_SHAPE * SCH_IO_KICAD_LEGACY_LIB_CACHE::loadPolyLine ( LINE_READER &  aReader)
staticprivate

Definition at line 1305 of file sch_io_kicad_legacy_lib_cache.cpp.

References SCH_SHAPE::AddPoint(), LAYER_DEVICE, LINE_READER::Line(), EDA_IU_SCALE::MilsToIU(), parseFillMode(), parseInt(), schIUScale, SCH_ITEM::SetBodyStyle(), EDA_SHAPE::SetFillMode(), SCH_SHAPE::SetStroke(), SCH_ITEM::SetUnit(), strCompare(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by loadDrawEntries().

◆ loadRect()

SCH_SHAPE * SCH_IO_KICAD_LEGACY_LIB_CACHE::loadRect ( LINE_READER &  aReader)
staticprivate

Definition at line 1048 of file sch_io_kicad_legacy_lib_cache.cpp.

References LAYER_DEVICE, LINE_READER::Line(), EDA_IU_SCALE::MilsToIU(), parseFillMode(), parseInt(), schIUScale, SCH_ITEM::SetBodyStyle(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFillMode(), SCH_SHAPE::SetPosition(), SCH_SHAPE::SetStroke(), SCH_ITEM::SetUnit(), strCompare(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by loadDrawEntries().

◆ loadText()

SCH_TEXT * SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText ( LINE_READER &  aReader,
int  aMajorVersion,
int  aMinorVersion 
)
staticprivate

Definition at line 950 of file sch_io_kicad_legacy_lib_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(), LAYER_DEVICE, 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_IO_KICAD_LEGACY_LIB_CACHE::parseFillMode ( LINE_READER &  aReader,
const char *  aLine,
const char **  aOutput 
)
staticprivate

Definition at line 760 of file sch_io_kicad_legacy_lib_cache.cpp.

References parseChar(), and SCH_PARSE_ERROR.

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

◆ removeSymbol()

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

Definition at line 94 of file sch_io_lib_cache.cpp.

References LIB_SYMBOL::AddDrawItem(), EDA_ITEM::Clone(), LIB_SYMBOL::FindField(), SCH_FIELD::GetCanonicalName(), LIB_SYMBOL::GetDrawItems(), LIB_SYMBOL::GetName(), 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, SCH_FIELD_T, EDA_ITEM::SetParent(), and LIB_SYMBOL::SharedPtr().

Referenced by SCH_IO_LIB_CACHE::AddSymbol().

◆ Save()

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

Save the entire library to file m_libFileName;.

Reimplemented from SCH_IO_LIB_CACHE.

Definition at line 1415 of file sch_io_kicad_legacy_lib_cache.cpp.

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

Referenced by SCH_IO_KICAD_LEGACY::CreateLibrary(), SCH_IO_KICAD_LEGACY::DeleteSymbol(), SCH_IO_KICAD_LEGACY::SaveLibrary(), and SCH_IO_KICAD_LEGACY::SaveSymbol().

◆ saveArc()

void SCH_IO_KICAD_LEGACY_LIB_CACHE::saveArc ( SCH_SHAPE *  aArc,
OUTPUTFORMATTER &  aFormatter 
)
staticprivate

Definition at line 1612 of file sch_io_kicad_legacy_lib_cache.cpp.

References EDA_ANGLE::AsTenthsOfADegree(), EDA_SHAPE::CalcArcAngles(), fill_tab, SCH_ITEM::GetBodyStyle(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetFillMode(), SCH_SHAPE::GetPosition(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), SCH_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_IO_KICAD_LEGACY_LIB_CACHE::saveBezier ( SCH_SHAPE *  aBezier,
OUTPUTFORMATTER &  aFormatter 
)
staticprivate

Definition at line 1639 of file sch_io_kicad_legacy_lib_cache.cpp.

References fill_tab, EDA_SHAPE::GetBezierC1(), EDA_SHAPE::GetBezierC2(), SCH_ITEM::GetBodyStyle(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetFillMode(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), SCH_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_IO_KICAD_LEGACY_LIB_CACHE::saveCircle ( SCH_SHAPE *  aCircle,
OUTPUTFORMATTER &  aFormatter 
)
staticprivate

Definition at line 1662 of file sch_io_kicad_legacy_lib_cache.cpp.

References fill_tab, SCH_ITEM::GetBodyStyle(), EDA_SHAPE::GetFillMode(), SCH_SHAPE::GetPosition(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), SCH_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_IO_KICAD_LEGACY_LIB_CACHE::saveDocFile ( )
private

Definition at line 1870 of file sch_io_kicad_legacy_lib_cache.cpp.

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

Referenced by Save().

◆ saveField()

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

Definition at line 1677 of file sch_io_kicad_legacy_lib_cache.cpp.

References EscapedUTF8(), TEMPLATE_FIELDNAME::GetDefaultFieldName(), EDA_TEXT::GetHorizJustify(), SCH_FIELD::GetId(), SCH_FIELD::GetName(), 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(), MANDATORY_FIELDS, OUTPUTFORMATTER::Print(), SCH_FIELD_T, schIUScale, text, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SaveSymbol().

◆ savePin()

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

Definition at line 1726 of file sch_io_kicad_legacy_lib_cache.cpp.

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

Referenced by SaveSymbol().

◆ savePolyLine()

void SCH_IO_KICAD_LEGACY_LIB_CACHE::savePolyLine ( SCH_SHAPE *  aPolyLine,
OUTPUTFORMATTER &  aFormatter 
)
staticprivate

Definition at line 1791 of file sch_io_kicad_legacy_lib_cache.cpp.

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

Referenced by SaveSymbol().

◆ saveRectangle()

void SCH_IO_KICAD_LEGACY_LIB_CACHE::saveRectangle ( SCH_SHAPE *  aRectangle,
OUTPUTFORMATTER &  aFormatter 
)
staticprivate

Definition at line 1809 of file sch_io_kicad_legacy_lib_cache.cpp.

References fill_tab, SCH_ITEM::GetBodyStyle(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetFillMode(), SCH_SHAPE::GetPosition(), EDA_SHAPE::GetShape(), SCH_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_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol ( LIB_SYMBOL *  aSymbol,
OUTPUTFORMATTER &  aFormatter,
LIB_SYMBOL_MAP *  aMap = nullptr 
)
static

Definition at line 1450 of file sch_io_kicad_legacy_lib_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(), SYMBOL::GetPinNameOffset(), LIB_SYMBOL::GetReferenceField(), EDA_SHAPE::GetShape(), SYMBOL::GetShowPinNames(), SYMBOL::GetShowPinNumbers(), EDA_TEXT::GetText(), LIB_SYMBOL::GetUnitCount(), LIB_SYMBOL::GetValueField(), LIB_SYMBOL::IsAlias(), LIB_SYMBOL::IsPower(), LIB_SYMBOL::IsRoot(), EDA_IU_SCALE::IUToMils(), MANDATORY_FIELDS, OUTPUTFORMATTER::Print(), saveArc(), saveBezier(), saveCircle(), saveField(), savePin(), savePolyLine(), saveRectangle(), saveText(), SCH_PIN_T, SCH_SHAPE_T, SCH_TEXT_T, schIUScale, LIB_SYMBOL::SharedPtr(), MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::sort(), TO_UTF8, and LIB_SYMBOL::UnitsLocked().

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

◆ saveText()

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

Definition at line 1827 of file sch_io_kicad_legacy_lib_cache.cpp.

References EDA_ANGLE::AsTenthsOfADegree(), SCH_ITEM::GetBodyStyle(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextWidth(), SCH_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(), OUTPUTFORMATTER::Print(), SCH_TEXT_T, schIUScale, text, TO_UTF8, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SaveSymbol().

◆ SetFileName()

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

Definition at line 86 of file sch_io_lib_cache.h.

References SCH_IO_LIB_CACHE::m_libFileName.

Referenced by EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), SCH_IO_KICAD_LEGACY::SaveLibrary(), and SCH_IO_KICAD_SEXPR::SaveLibrary().

◆ SetModified()

void SCH_IO_LIB_CACHE::SetModified ( bool  aModified = true)
inlineinherited

Definition at line 82 of file sch_io_lib_cache.h.

References SCH_IO_LIB_CACHE::m_isModified.

Referenced by SCH_IO_KICAD_LEGACY::CreateLibrary(), SCH_IO_KICAD_SEXPR::CreateLibrary(), EESCHEMA_JOBS_HANDLER::JobSymUpgrade(), SCH_IO_KICAD_LEGACY::SaveLibrary(), and SCH_IO_KICAD_SEXPR::SaveLibrary().

Member Data Documentation

◆ m_fileModTime

wxDateTime SCH_IO_LIB_CACHE::m_fileModTime
protectedinherited

Definition at line 100 of file sch_io_lib_cache.h.

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

◆ 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

bool SCH_IO_LIB_CACHE::m_isModified
protectedinherited

Definition at line 103 of file sch_io_lib_cache.h.

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

◆ 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

wxFileName SCH_IO_LIB_CACHE::m_libFileName
protectedinherited

Definition at line 99 of file sch_io_lib_cache.h.

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

◆ m_libType

SCH_LIB_TYPE SCH_IO_LIB_CACHE::m_libType
protectedinherited

Definition at line 104 of file sch_io_lib_cache.h.

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

◆ m_modHash

int SCH_IO_LIB_CACHE::m_modHash
protectedinherited

Definition at line 95 of file sch_io_lib_cache.h.

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

◆ m_modHashMutex

std::mutex SCH_IO_LIB_CACHE::m_modHashMutex
protectedinherited

Definition at line 96 of file sch_io_lib_cache.h.

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

◆ m_symbols

LIB_SYMBOL_MAP SCH_IO_LIB_CACHE::m_symbols
protectedinherited

Definition at line 101 of file sch_io_lib_cache.h.

Referenced by SCH_IO_LIB_CACHE::AddSymbol(), DeleteSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::DeleteSymbol(), SCH_IO_KICAD_LEGACY::EnumerateSymbolLib(), SCH_IO_KICAD_SEXPR::EnumerateSymbolLib(), SCH_IO_KICAD_SEXPR::GetAvailableSymbolFields(), SCH_IO_LIB_CACHE::GetSymbol(), SCH_IO_LIB_CACHE::GetSymbolMap(), Load(), SCH_IO_KICAD_SEXPR_LIB_CACHE::Load(), loadDocs(), SCH_IO_KICAD_LEGACY::LoadSymbol(), SCH_IO_KICAD_SEXPR::LoadSymbol(), SCH_IO_LIB_CACHE::removeSymbol(), Save(), SCH_IO_KICAD_SEXPR_LIB_CACHE::Save(), saveDocFile(), and SCH_IO_LIB_CACHE::~SCH_IO_LIB_CACHE().

◆ m_versionMajor

int SCH_IO_KICAD_LEGACY_LIB_CACHE::m_versionMajor
private

Definition at line 97 of file sch_io_kicad_legacy_lib_cache.h.

Referenced by Load(), and SCH_IO_KICAD_LEGACY_LIB_CACHE().

◆ m_versionMinor

int SCH_IO_KICAD_LEGACY_LIB_CACHE::m_versionMinor
private

Definition at line 98 of file sch_io_kicad_legacy_lib_cache.h.

Referenced by Load(), and SCH_IO_KICAD_LEGACY_LIB_CACHE().

◆ SCH_IO_KICAD_LEGACY

friend SCH_IO_KICAD_LEGACY_LIB_CACHE::SCH_IO_KICAD_LEGACY
private

Definition at line 66 of file sch_io_kicad_legacy_lib_cache.h.

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