SCH_IO_KICAD_LEGACY Class Reference

A SCH_IO derivation for loading schematic files created before the new s-expression file format. More...

#include <sch_io_kicad_legacy.h>

Inheritance diagram for SCH_IO_KICAD_LEGACY:

Public Member Functions
	SCH_IO_KICAD_LEGACY ()
virtual	~SCH_IO_KICAD_LEGACY ()
const IO_BASE::IO_FILE_DESC	GetSchematicFileDesc () const override
	Returns schematic file description for the SCH_IO.
const IO_BASE::IO_FILE_DESC	GetLibraryDesc () const override
	Get the descriptor for the library container that this IO plugin operates on.
bool	CanReadSchematicFile (const wxString &aFileName) const override
	Checks if this SCH_IO can read the specified schematic file.
bool	CanReadLibrary (const wxString &aFileName) const override
	Checks if this IO object can read the specified library file/directory.
int	GetModifyHash () const override
	Return the modification hash from the library cache.
SCH_SHEET *	LoadSchematicFile (const wxString &aFileName, SCHEMATIC *aSchematic, SCH_SHEET *aAppendToMe=nullptr, const STRING_UTF8_MAP *aProperties=nullptr) override
	Load information from some input file format that this SCH_IO implementation knows about, into either a new SCH_SHEET or an existing one.
void	LoadContent (LINE_READER &aReader, SCH_SCREEN *aScreen, int version=EESCHEMA_VERSION)
void	SaveSchematicFile (const wxString &aFileName, SCH_SHEET *aScreen, SCHEMATIC *aSchematic, const STRING_UTF8_MAP *aProperties=nullptr) override
	Write aSchematic to a storage file in a format that this SCH_IO implementation knows about, or it can be used to write a portion of aSchematic to a special kind of export file.
void	Format (SCH_SHEET *aSheet)
void	Format (SELECTION *aSelection, OUTPUTFORMATTER *aFormatter)
void	EnumerateSymbolLib (wxArrayString &aSymbolNameList, const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
	Populate a list of LIB_SYMBOL alias names contained within the library aLibraryPath.
void	EnumerateSymbolLib (std::vector< LIB_SYMBOL * > &aSymbolList, const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
	Populate a list of LIB_SYMBOL aliases contained within the library aLibraryPath.
LIB_SYMBOL *	LoadSymbol (const wxString &aLibraryPath, const wxString &aAliasName, const STRING_UTF8_MAP *aProperties=nullptr) override
	Load a LIB_SYMBOL object having aPartName from the aLibraryPath containing a library format that this SCH_IO knows about.
void	SaveSymbol (const wxString &aLibraryPath, const LIB_SYMBOL *aSymbol, const STRING_UTF8_MAP *aProperties=nullptr) override
	Write aSymbol to an existing library located at aLibraryPath.
void	DeleteSymbol (const wxString &aLibraryPath, const wxString &aSymbolName, const STRING_UTF8_MAP *aProperties=nullptr) override
	Delete the entire LIB_SYMBOL associated with aAliasName from the library aLibraryPath.
void	CreateLibrary (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
	Create a new empty library at aLibraryPath empty.
bool	DeleteLibrary (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
	Delete an existing library and returns true, or if library does not exist returns false, or throws an exception if library exists but is read only or cannot be deleted for some other reason.
void	SaveLibrary (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
bool	IsLibraryWritable (const wxString &aLibraryPath) override
	Return true if the library at aLibraryPath is writable.
const wxString &	GetError () const override
	Return an error string to the caller.
virtual void	GetLibraryOptions (STRING_UTF8_MAP *aListToAppendTo) const override
	Append supported SCH_IO options to aListToAppenTo along with internationalized descriptions.
virtual bool	SupportsSubLibraries () const
virtual void	GetSubLibraryNames (std::vector< wxString > &aNames)
	Retrieves a list of sub-libraries in this library.
virtual void	GetAvailableSymbolFields (std::vector< wxString > &aNames)
	Retrieves a list of (custom) field names that are present on symbols in this library.
virtual void	GetDefaultSymbolFields (std::vector< wxString > &aNames)
	Retrieves a list of (custom) field names that should be shown by default for this library in the symbol chooser.
virtual void	SetLibTable (SYMBOL_LIB_TABLE *aTable)
	Some library plugins need to have access to their parent library table.
const wxString &	GetName () const
	Return a brief hard coded name for this IO interface.
virtual void	SetReporter (REPORTER *aReporter)
	Set an optional reporter for warnings/errors.
virtual void	SetProgressReporter (PROGRESS_REPORTER *aReporter)
	Set an optional progress reporter.
virtual const IO_FILE_DESC	GetLibraryFileDesc () const
	Get the descriptor for the individual library elements that this IO plugin operates on.

Static Public Member Functions
static LIB_SYMBOL *	ParsePart (LINE_READER &aReader, int majorVersion=0, int minorVersion=0)
static void	FormatPart (LIB_SYMBOL *aSymbol, OUTPUTFORMATTER &aFormatter)

Static Public Attributes
static const char *	PropBuffering = "buffering"
	The property used internally by the plugin to enable cache buffering which prevents the library file from being written every time the cache is changed.
static const char *	PropNoDocFile = "no_doc_file"
	The property used internally by the plugin to disable writing the library documentation (.dcm) file when saving the library cache.

Protected Member Functions
void	init (SCHEMATIC *aSchematic, const STRING_UTF8_MAP *aProperties=nullptr)
	initialize PLUGIN like a constructor would.

Protected Attributes
int	m_version
	Version of file being loaded.
bool	m_appending
wxString	m_error
	For throwing exceptions or errors on partial schematic loads.
LINE_READER *	m_lineReader
	for progress reporting
unsigned	m_lastProgressLine
unsigned	m_lineCount
	for progress reporting
wxString	m_path
	Root project path for loading child sheets.
std::stack< wxString >	m_currentPath
	Stack to maintain nested sheet paths.
SCH_SHEET *	m_rootSheet
	The root sheet of the schematic being loaded.
SCH_SHEET *	m_currentSheet
	The sheet currently being loaded.
OUTPUTFORMATTER *	m_out
	The formatter for saving SCH_SCREEN objects.
SCH_IO_KICAD_LEGACY_LIB_CACHE *	m_cache
SCHEMATIC *	m_schematic
wxString	m_name
	Name of the IO loader.
REPORTER *	m_reporter
	Reporter to log errors/warnings to, may be nullptr.
PROGRESS_REPORTER *	m_progressReporter
	Progress reporter to track the progress of the operation, may be nullptr.

Private Member Functions
void	checkpoint ()
void	loadHierarchy (SCH_SHEET *aSheet)
void	loadHeader (LINE_READER &aReader, SCH_SCREEN *aScreen)
void	loadPageSettings (LINE_READER &aReader, SCH_SCREEN *aScreen)
void	loadFile (const wxString &aFileName, SCH_SCREEN *aScreen)
SCH_SHEET *	loadSheet (LINE_READER &aReader)
SCH_BITMAP *	loadBitmap (LINE_READER &aReader)
SCH_JUNCTION *	loadJunction (LINE_READER &aReader)
SCH_NO_CONNECT *	loadNoConnect (LINE_READER &aReader)
SCH_LINE *	loadWire (LINE_READER &aReader)
SCH_BUS_ENTRY_BASE *	loadBusEntry (LINE_READER &aReader)
SCH_TEXT *	loadText (LINE_READER &aReader)
SCH_SYMBOL *	loadSymbol (LINE_READER &aReader)
std::shared_ptr< BUS_ALIAS >	loadBusAlias (LINE_READER &aReader, SCH_SCREEN *aScreen)
void	saveSymbol (SCH_SYMBOL *aSymbol)
void	saveField (SCH_FIELD *aField)
void	saveBitmap (SCH_BITMAP *aBitmap)
void	saveSheet (SCH_SHEET *aSheet)
void	saveJunction (SCH_JUNCTION *aJunction)
void	saveNoConnect (SCH_NO_CONNECT *aNoConnect)
void	saveBusEntry (SCH_BUS_ENTRY_BASE *aBusEntry)
void	saveLine (SCH_LINE *aLine)
void	saveText (SCH_TEXT *aText)
void	saveBusAlias (std::shared_ptr< BUS_ALIAS > aAlias)
void	cacheLib (const wxString &aLibraryFileName, const STRING_UTF8_MAP *aProperties)
bool	writeDocFile (const STRING_UTF8_MAP *aProperties)
bool	isBuffering (const STRING_UTF8_MAP *aProperties)

Detailed Description

A SCH_IO derivation for loading schematic files created before the new s-expression file format.

The legacy parser and formatter attempt to be compatible with the legacy file format. The original parser was very forgiving in that it would parse only part of a keyword. So "$C", "$Co", and "$Com" could be used for "$Comp" and the old parser would allow this. This parser is not that forgiving and sticks to the legacy file format document.

As with all SCH_IO there is no UI dependencies i.e. windowing calls allowed.

Definition at line 66 of file sch_io_kicad_legacy.h.

Constructor & Destructor Documentation

SCH_IO_KICAD_LEGACY()

SCH_IO_KICAD_LEGACY::SCH_IO_KICAD_LEGACY

(

)

Definition at line 75 of file sch_io_kicad_legacy.cpp.

References init().

~SCH_IO_KICAD_LEGACY()

SCH_IO_KICAD_LEGACY::~SCH_IO_KICAD_LEGACY ( )

virtual

Definition at line 85 of file sch_io_kicad_legacy.cpp.

References m_cache.

Member Function Documentation

cacheLib()

void SCH_IO_KICAD_LEGACY::cacheLib ( const wxString &  aLibraryFileName, const STRING_UTF8_MAP *  aProperties  )

private

Definition at line 2096 of file sch_io_kicad_legacy.cpp.

References isBuffering(), SCH_IO_LIB_CACHE::IsFile(), SCH_IO_LIB_CACHE::IsFileChanged(), SCH_IO_KICAD_LEGACY_LIB_CACHE::Load(), and m_cache.

Referenced by DeleteSymbol(), EnumerateSymbolLib(), LoadSymbol(), and SaveSymbol().

CanReadLibrary()

bool SCH_IO_KICAD_LEGACY::CanReadLibrary ( const wxString &  aFileName ) const

overridevirtual

Checks if this IO object can read the specified library file/directory.

If not overriden, extension check is used.

Note

This is not a check that the file system object is readable by the user, but a check that this IO object can parse the given library.

Reimplemented from IO_BASE.

Definition at line 2299 of file sch_io_kicad_legacy.cpp.

References IO_BASE::CanReadLibrary(), and IO_UTILS::fileStartsWithPrefix().

CanReadSchematicFile()

bool SCH_IO_KICAD_LEGACY::CanReadSchematicFile ( const wxString &  aFileName ) const

overridevirtual

Checks if this SCH_IO can read the specified schematic file.

If not overriden, extension check is used.

Reimplemented from SCH_IO.

Definition at line 2290 of file sch_io_kicad_legacy.cpp.

References SCH_IO::CanReadSchematicFile(), and IO_UTILS::fileStartsWithPrefix().

checkpoint()

void SCH_IO_KICAD_LEGACY::checkpoint ( )

private

Definition at line 102 of file sch_io_kicad_legacy.cpp.

References _, PROGRESS_REPORTER::KeepRefreshing(), LINE_READER::LineNumber(), m_lastProgressLine, m_lineCount, m_lineReader, IO_BASE::m_progressReporter, PROGRESS_REPORTER::SetCurrentProgress(), and THROW_IO_ERROR.

Referenced by LoadContent(), and loadHeader().

CreateLibrary()

void SCH_IO_KICAD_LEGACY::CreateLibrary ( const wxString &  aLibraryPath, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Create a new empty library at aLibraryPath empty.

It is an error to attempt to create an existing library or to attempt to create on a "read only" location.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several elements.
aProperties	is an associative array that can be used to tell the library create function anything special, because it can take any number of additional named tuning arguments that the IO is known to support. The caller continues to own this object (IO may not delete it), and IOs should expect it to be optionally NULL.

Exceptions

IO_ERROR

if there is a problem finding the library, or creating it.

Reimplemented from IO_BASE.

Definition at line 2225 of file sch_io_kicad_legacy.cpp.

References _, SCH_IO_KICAD_LEGACY_LIB_CACHE::Load(), m_cache, SCH_IO_KICAD_LEGACY_LIB_CACHE::Save(), SCH_IO_LIB_CACHE::SetModified(), THROW_IO_ERROR, and writeDocFile().

DeleteLibrary()

bool SCH_IO_KICAD_LEGACY::DeleteLibrary ( const wxString &  aLibraryPath, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Delete an existing library and returns true, or if library does not exist returns false, or throws an exception if library exists but is read only or cannot be deleted for some other reason.

Parameters

aLibraryPath	is a locator for the "library", usually a directory or file which will contain several elements.
aProperties	is an associative array that can be used to tell the library delete implementation function anything special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Returns

true if library deleted, false if library did not exist.

Exceptions

IO_ERROR

if there is a problem deleting an existing library.

Reimplemented from IO_BASE.

Definition at line 2244 of file sch_io_kicad_legacy.cpp.

References _, SCH_IO_LIB_CACHE::IsFile(), m_cache, and THROW_IO_ERROR.

DeleteSymbol()

void SCH_IO_KICAD_LEGACY::DeleteSymbol ( const wxString &  aLibraryPath, const wxString &  aSymbolName, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Delete the entire LIB_SYMBOL associated with aAliasName from the library aLibraryPath.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several symbols.
aSymbolName	is the name of a LIB_SYMBOL associated with it's root LIB_SYMBOL object to delete from the specified library.
aProperties	is an associative array that can be used to tell the library delete function anything special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Exceptions

IO_ERROR

if there is a problem finding the alias or the library or deleting it.

Reimplemented from SCH_IO.

Definition at line 2211 of file sch_io_kicad_legacy.cpp.

References cacheLib(), SCH_IO_KICAD_LEGACY_LIB_CACHE::DeleteSymbol(), isBuffering(), m_cache, SCH_IO_KICAD_LEGACY_LIB_CACHE::Save(), and writeDocFile().

EnumerateSymbolLib() [1/2]

void SCH_IO_KICAD_LEGACY::EnumerateSymbolLib ( std::vector< LIB_SYMBOL * > &  aSymbolList, const wxString &  aLibraryPath, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Populate a list of LIB_SYMBOL aliases contained within the library aLibraryPath.

Note

It is the responsibility of the caller to delete the returned object from the heap. Failure to do this will result in memory leaks.

Parameters

aSymbolList	is an array to populate with the LIB_SYMBOL pointers associated with the library.
aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing one or more LIB_SYMBOL objects.
aProperties	is an associative array that can be used to tell the plugin anything needed about how to perform with respect to aLibraryPath. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Exceptions

IO_ERROR

if the library cannot be found, the part library cannot be loaded.

Reimplemented from SCH_IO.

Definition at line 2159 of file sch_io_kicad_legacy.cpp.

References cacheLib(), m_cache, SCH_IO_LIB_CACHE::m_symbols, and SYMBOL_LIB_TABLE::PropPowerSymsOnly.

EnumerateSymbolLib() [2/2]

void SCH_IO_KICAD_LEGACY::EnumerateSymbolLib ( wxArrayString &  aSymbolNameList, const wxString &  aLibraryPath, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Populate a list of LIB_SYMBOL alias names contained within the library aLibraryPath.

Parameters

aSymbolNameList	is an array to populate with the LIB_SYMBOL names associated with the library.
aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing one or more LIB_SYMBOL objects.
aProperties	is an associative array that can be used to tell the plugin anything needed about how to perform with respect to aLibraryPath. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Exceptions

IO_ERROR

if the library cannot be found, the part library cannot be loaded.

Reimplemented from SCH_IO.

Definition at line 2138 of file sch_io_kicad_legacy.cpp.

References cacheLib(), m_cache, SCH_IO_LIB_CACHE::m_symbols, and SYMBOL_LIB_TABLE::PropPowerSymsOnly.

Format() [1/2]

void SCH_IO_KICAD_LEGACY::Format

(

SCH_SHEET *

aSheet

)

Definition at line 1527 of file sch_io_kicad_legacy.cpp.

References EESCHEMA_VERSION, EscapedUTF8(), SCH_SCREEN::GetBusAliases(), TITLE_BLOCK::GetComment(), TITLE_BLOCK::GetCompany(), TITLE_BLOCK::GetDate(), PAGE_INFO::GetHeightMils(), BASE_SCREEN::GetPageCount(), SCH_SCREEN::GetPageSettings(), TITLE_BLOCK::GetRevision(), SCH_SHEET::GetScreen(), TITLE_BLOCK::GetTitle(), SCH_SCREEN::GetTitleBlock(), PAGE_INFO::GetType(), BASE_SCREEN::GetVirtualPageNumber(), PAGE_INFO::GetWidthMils(), PAGE_INFO::IsCustom(), PAGE_INFO::IsPortrait(), SCH_SCREEN::Items(), m_out, m_schematic, OUTPUTFORMATTER::Print(), saveBitmap(), saveBusAlias(), saveBusEntry(), saveJunction(), saveLine(), saveNoConnect(), saveSheet(), saveSymbol(), saveText(), SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LAYER_ID_COUNT, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TEXT_T, SCHEMATIC_HEAD_STRING, and TO_UTF8.

Referenced by SaveSchematicFile().

Format() [2/2]

void SCH_IO_KICAD_LEGACY::Format	(	SELECTION *	aSelection,
		OUTPUTFORMATTER *	aFormatter
	)

Definition at line 1624 of file sch_io_kicad_legacy.cpp.

References SELECTION::GetItem(), SELECTION::GetSize(), m_out, saveBitmap(), saveBusEntry(), saveJunction(), saveLine(), saveNoConnect(), saveSheet(), saveSymbol(), saveText(), SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TEXT_T, and EDA_ITEM::Type().

FormatPart()

void SCH_IO_KICAD_LEGACY::FormatPart ( LIB_SYMBOL *  aSymbol, OUTPUTFORMATTER &  aFormatter  )

static

Definition at line 2322 of file sch_io_kicad_legacy.cpp.

References SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol().

GetAvailableSymbolFields()

virtual void SCH_IO::GetAvailableSymbolFields ( std::vector< wxString > &  aNames )

inlinevirtualinherited

Retrieves a list of (custom) field names that are present on symbols in this library.

The plugin is responsible for guaranteeing that this list contains the set of unique custom field names present on any symbols contained in the library.

The required KiCad fields are not included in this list.

Parameters

aNames

will be filled with any custom fields present in this library.

Reimplemented in SCH_IO_CADSTAR_ARCHIVE, SCH_IO_DATABASE, SCH_IO_HTTP_LIB, and SCH_IO_KICAD_SEXPR.

Definition at line 313 of file sch_io.h.

Referenced by SCH_IO::GetDefaultSymbolFields().

GetDefaultSymbolFields()

virtual void SCH_IO::GetDefaultSymbolFields ( std::vector< wxString > &  aNames )

inlinevirtualinherited

Retrieves a list of (custom) field names that should be shown by default for this library in the symbol chooser.

This list should be a subset of the result returned by GetAvailableSymbolFields().

The preference for which fields to hide and show for a given library is stored on a per-library basis in a user's preferences (or in the project local settings for a project- local library). The set of fields returned by GetDefaultSymbolFields() will be used if this preference is missing.

Parameters

aNames

will be filled with the custom field names that should be shown by default

Reimplemented in SCH_IO_DATABASE, SCH_IO_HTTP_LIB, and SCH_IO_KICAD_SEXPR.

Definition at line 327 of file sch_io.h.

References SCH_IO::GetAvailableSymbolFields().

GetError()

const wxString & SCH_IO_KICAD_LEGACY::GetError ( ) const

inlineoverridevirtual

Return an error string to the caller.

This is useful for schematic loaders that can load partial schematics where throwing an exception would be problematic such as the KiCad legacy plugin.

Returns

an unformatted string containing errors if any.

Reimplemented from SCH_IO.

Definition at line 139 of file sch_io_kicad_legacy.h.

References m_error.

GetLibraryDesc()

const IO_BASE::IO_FILE_DESC SCH_IO_KICAD_LEGACY::GetLibraryDesc ( ) const

inlineoverridevirtual

Get the descriptor for the library container that this IO plugin operates on.

Returns

File descriptor for the container of the library elements

Implements IO_BASE.

Definition at line 79 of file sch_io_kicad_legacy.h.

References _HKI, and FILEEXT::LegacySymbolLibFileExtension.

GetLibraryFileDesc()

virtual const IO_FILE_DESC IO_BASE::GetLibraryFileDesc ( ) const

inlinevirtualinherited

Get the descriptor for the individual library elements that this IO plugin operates on.

For libraries where all the elements are in a single container (e.g. all elements in a single file), then this will return the descriptor from IO_BASE::GetLibraryDesc().

Returns

File descriptor for the library elements

Reimplemented in PCB_IO_EASYEDA, PCB_IO_EASYEDAPRO, PCB_IO_GEDA, and PCB_IO_KICAD_SEXPR.

Definition at line 102 of file io_base.h.

References IO_BASE::GetLibraryDesc().

Referenced by PCB_IO::CanReadFootprint().

GetLibraryOptions()

void SCH_IO::GetLibraryOptions ( STRING_UTF8_MAP *  aListToAppendTo ) const

overridevirtualinherited

Append supported SCH_IO options to aListToAppenTo along with internationalized descriptions.

Options are typically appended so that a derived SCH_IO can call its base class function by the same name first, thus inheriting options declared there. (Some base class options could pertain to all Symbol*() functions in all derived SCH_IOs.) Note that since aListToAppendTo is a PROPERTIES object, all options will be unique and last guy wins.

Parameters

aListToAppendTo

holds a tuple of option This eventually is what shows up into the fp-lib-table "options" field, possibly combined with others. internationalized description The internationalized description is displayed in DIALOG_PLUGIN_OPTIONS. It may be multi-line and be quite explanatory of the option. In the future perhaps aListToAppendTo evolves to something capable of also holding a wxValidator for the cells in said dialog: http://forums.wxwidgets.org/viewtopic.php?t=23277&p=104180. This would require a 3 column list, and introducing wx GUI knowledge to SCH_IO, which has been avoided to date.

Reimplemented from IO_BASE.

Reimplemented in SCH_IO_CADSTAR_ARCHIVE.

Definition at line 125 of file sch_io.cpp.

References IO_BASE::GetLibraryOptions().

GetModifyHash()

int SCH_IO_KICAD_LEGACY::GetModifyHash ( ) const

overridevirtual

Return the modification hash from the library cache.

Note

This is temporary until the new s-expr file format is implement. The new file format will embed symbols instead of referencing them from the library. This function can be removed when the new file format is implemented.

Returns

the modification hash of the library cache.

Implements SCH_IO.

Definition at line 2128 of file sch_io_kicad_legacy.cpp.

References SCH_IO_LIB_CACHE::GetModifyHash(), and m_cache.

GetName()

const wxString & IO_BASE::GetName ( ) const

inlineinherited

Return a brief hard coded name for this IO interface.

Definition at line 71 of file io_base.h.

References IO_BASE::m_name.

Referenced by SCH_IO_ALTIUM::ParseLibFile().

GetSchematicFileDesc()

const IO_BASE::IO_FILE_DESC SCH_IO_KICAD_LEGACY::GetSchematicFileDesc ( ) const

inlineoverridevirtual

Returns schematic file description for the SCH_IO.

Reimplemented from SCH_IO.

Definition at line 73 of file sch_io_kicad_legacy.h.

References _HKI, and FILEEXT::LegacySchematicFileExtension.

GetSubLibraryNames()

virtual void SCH_IO::GetSubLibraryNames ( std::vector< wxString > &  aNames )

inlinevirtualinherited

Retrieves a list of sub-libraries in this library.

Some types of symbol library support sub-libraries, which are a single-level organizational hierarchy that is implementation-defined per plugin. Most of KiCad ignores sub-libraries and treats the hierarchy between library and symbol as flat, but the sub-libraries are used for sorting and grouping symbols in the symbol chooser.

Has no effect if SupportsSubLibraries() returns false.

Parameters

aNames

will be filled with a list of sub-libraries within this symbol library

Reimplemented in SCH_IO_DATABASE, and SCH_IO_HTTP_LIB.

Definition at line 302 of file sch_io.h.

init()

void SCH_IO_KICAD_LEGACY::init ( SCHEMATIC *  aSchematic, const STRING_UTF8_MAP *  aProperties = nullptr  )

protected

initialize PLUGIN like a constructor would.

Definition at line 91 of file sch_io_kicad_legacy.cpp.

References m_cache, m_currentSheet, m_out, m_rootSheet, m_schematic, and m_version.

Referenced by LoadSchematicFile(), SaveSchematicFile(), and SCH_IO_KICAD_LEGACY().

isBuffering()

bool SCH_IO_KICAD_LEGACY::isBuffering ( const STRING_UTF8_MAP *  aProperties )

private

Definition at line 2122 of file sch_io_kicad_legacy.cpp.

References STRING_UTF8_MAP::Exists(), and PropBuffering.

Referenced by cacheLib(), DeleteSymbol(), and SaveSymbol().

IsLibraryWritable()

bool SCH_IO_KICAD_LEGACY::IsLibraryWritable ( const wxString &  aLibraryPath )

overridevirtual

Return true if the library at aLibraryPath is writable.

The system libraries are typically read only because of where they are installed..

Parameters

aLibraryPath

is a locator for the "library", usually a directory, file, or URL containing several footprints.

Exceptions

IO_ERROR

if no library at aLibraryPath exists.

Reimplemented from IO_BASE.

Definition at line 2308 of file sch_io_kicad_legacy.cpp.

loadBitmap()

SCH_BITMAP * SCH_IO_KICAD_LEGACY::loadBitmap ( LINE_READER &  aReader )

private

Definition at line 646 of file sch_io_kicad_legacy.cpp.

References _, BITMAP_BASE::GetPPI(), BITMAP_BASE::GetScale(), LINE_READER::Line(), EDA_IU_SCALE::MilsToIU(), parseDouble(), parseInt(), LINE_READER::ReadLine(), SCH_PARSE_ERROR, schIUScale, BITMAP_BASE::SetScale(), strCompare(), THROW_IO_ERROR, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by LoadContent().

loadBusAlias()

std::shared_ptr< BUS_ALIAS > SCH_IO_KICAD_LEGACY::loadBusAlias ( LINE_READER &  aReader, SCH_SCREEN *  aScreen  )

private

Definition at line 1475 of file sch_io_kicad_legacy.cpp.

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

Referenced by LoadContent().

loadBusEntry()

SCH_BUS_ENTRY_BASE * SCH_IO_KICAD_LEGACY::loadBusEntry ( LINE_READER &  aReader )

private

Definition at line 891 of file sch_io_kicad_legacy.cpp.

References LINE_READER::Line(), EDA_IU_SCALE::MilsToIU(), parseInt(), LINE_READER::ReadLine(), SCH_PARSE_ERROR, schIUScale, strCompare(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by LoadContent().

LoadContent()

void SCH_IO_KICAD_LEGACY::LoadContent	(	LINE_READER &	aReader,
		SCH_SCREEN *	aScreen,
		int	version = EESCHEMA_VERSION
	)

Definition at line 318 of file sch_io_kicad_legacy.cpp.

References SCH_SCREEN::AddBusAlias(), SCH_SCREEN::Append(), checkpoint(), LINE_READER::Line(), loadBitmap(), loadBusAlias(), loadBusEntry(), loadJunction(), loadNoConnect(), loadPageSettings(), loadSheet(), loadSymbol(), loadText(), loadWire(), m_rootSheet, m_version, LINE_READER::ReadLine(), SCH_PARSE_ERROR, and strCompare().

Referenced by loadFile().

loadFile()

void SCH_IO_KICAD_LEGACY::loadFile ( const wxString &  aFileName, SCH_SCREEN *  aScreen  )

private

Definition at line 279 of file sch_io_kicad_legacy.cpp.

References _, PROGRESS_REPORTER::KeepRefreshing(), LINE_READER::Line(), LoadContent(), loadHeader(), m_lineCount, m_lineReader, IO_BASE::m_progressReporter, m_version, FILE_LINE_READER::ReadLine(), PROGRESS_REPORTER::Report(), FILE_LINE_READER::Rewind(), strCompare(), and THROW_IO_ERROR.

Referenced by loadHierarchy().

loadHeader()

void SCH_IO_KICAD_LEGACY::loadHeader ( LINE_READER &  aReader, SCH_SCREEN *  aScreen  )

private

Definition at line 367 of file sch_io_kicad_legacy.cpp.

References _, checkpoint(), SCH_SCREEN::GetFileName(), LINE_READER::Line(), m_error, m_version, parseInt(), LINE_READER::ReadLine(), strCompare(), and THROW_IO_ERROR.

Referenced by loadFile().

loadHierarchy()

void SCH_IO_KICAD_LEGACY::loadHierarchy ( SCH_SHEET *  aSheet )

private

Definition at line 195 of file sch_io_kicad_legacy.cpp.

References SCH_SHEET::GetFileName(), SCH_SHEET::GetScreen(), SCH_SCREEN::GetUuid(), SCH_SCREEN::Items(), loadFile(), loadHierarchy(), m_currentPath, m_currentSheet, m_error, m_rootSheet, m_schematic, EDA_ITEM::m_Uuid, EE_RTREE::OfType(), SCH_SHEET_T, SCH_SHEET::SearchHierarchy(), SCH_SCREEN::SetFileExists(), SCH_SCREEN::SetFileName(), SCH_SCREEN::SetFileReadOnly(), EDA_ITEM::SetParent(), SCH_SHEET::SetScreen(), traceSchLegacyPlugin, and IO_ERROR::What().

Referenced by loadHierarchy(), and LoadSchematicFile().

loadJunction()

SCH_JUNCTION * SCH_IO_KICAD_LEGACY::loadJunction ( LINE_READER &  aReader )

private

Definition at line 737 of file sch_io_kicad_legacy.cpp.

References LINE_READER::Line(), EDA_IU_SCALE::MilsToIU(), name, parseInt(), parseUnquotedString(), schIUScale, strCompare(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by LoadContent().

loadNoConnect()

SCH_NO_CONNECT * SCH_IO_KICAD_LEGACY::loadNoConnect ( LINE_READER &  aReader )

private

Definition at line 759 of file sch_io_kicad_legacy.cpp.

References LINE_READER::Line(), EDA_IU_SCALE::MilsToIU(), name, parseInt(), parseUnquotedString(), schIUScale, strCompare(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by LoadContent().

loadPageSettings()

void SCH_IO_KICAD_LEGACY::loadPageSettings ( LINE_READER &  aReader, SCH_SCREEN *  aScreen  )

private

Definition at line 407 of file sch_io_kicad_legacy.cpp.

References _, PAGE_INFO::Custom, LINE_READER::Line(), parseInt(), parseQuotedString(), parseUnquotedString(), LINE_READER::ReadLine(), SCH_PARSE_ERROR, TITLE_BLOCK::SetComment(), TITLE_BLOCK::SetCompany(), TITLE_BLOCK::SetDate(), PAGE_INFO::SetHeightMils(), BASE_SCREEN::SetPageCount(), SCH_SCREEN::SetPageSettings(), PAGE_INFO::SetPortrait(), TITLE_BLOCK::SetRevision(), TITLE_BLOCK::SetTitle(), SCH_SCREEN::SetTitleBlock(), PAGE_INFO::SetType(), BASE_SCREEN::SetVirtualPageNumber(), PAGE_INFO::SetWidthMils(), and strCompare().

Referenced by LoadContent().

LoadSchematicFile()

SCH_SHEET * SCH_IO_KICAD_LEGACY::LoadSchematicFile ( const wxString &  aFileName, SCHEMATIC *  aSchematic, SCH_SHEET *  aAppendToMe = nullptr, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Load information from some input file format that this SCH_IO implementation knows about, into either a new SCH_SHEET or an existing one.

This may be used to load an entire new SCH_SHEET, or to augment an existing one if aAppendToMe is not NULL.

Parameters

aFileName	is the name of the file to use as input and may be foreign in nature or native in nature.
aKiway	is the KIWAY object used to access the symbol libraries loaded by the project.
aAppendToMe	is an existing SCH_SHEET to append to, but if NULL then this means "do not append, rather load anew".
aProperties	is an associative array that can be used to tell the loader how to load the file, because it can take any number of additional named arguments that the plugin is known to support. These are tuning parameters for the import or load. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Returns

the successfully loaded schematic, or the same one as aAppendToMe if aAppendToMe was not NULL, and the caller owns it.

Exceptions

IO_ERROR

if there is a problem loading, and its contents should say what went wrong, using line number and character offsets of the input file if possible.

Reimplemented from SCH_IO.

Definition at line 124 of file sch_io_kicad_legacy.cpp.

References SCH_SHEET::GetFileName(), PROJECT::GetProjectPath(), init(), SCHEMATIC::IsValid(), loadHierarchy(), m_appending, m_currentPath, m_path, m_rootSheet, SCHEMATIC::Prj(), SCHEMATIC::Root(), and traceSchLegacyPlugin.

loadSheet()

SCH_SHEET * SCH_IO_KICAD_LEGACY::loadSheet ( LINE_READER &  aReader )

private

Definition at line 536 of file sch_io_kicad_legacy.cpp.

References _, ConvertToNewOverbarNotation(), EDA_IU_SCALE::MilsToIU(), parseChar(), parseInt(), parseQuotedString(), parseUnquotedString(), LINE_READER::ReadLine(), SCH_PARSE_ERROR, schIUScale, SCH_FIELD::SetText(), EDA_TEXT::SetTextSize(), strCompare(), text, THROW_IO_ERROR, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by LoadContent().

LoadSymbol()

LIB_SYMBOL * SCH_IO_KICAD_LEGACY::LoadSymbol ( const wxString &  aLibraryPath, const wxString &  aPartName, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Load a LIB_SYMBOL object having aPartName from the aLibraryPath containing a library format that this SCH_IO knows about.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several symbols.
aPartName	is the name of the LIB_SYMBOL to load.
aProperties	is an associative array that can be used to tell the loader implementation to do something special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Returns

the part created on the heap if found caller shares it or NULL if not found.

Exceptions

IO_ERROR

if the library cannot be found or read. No exception is thrown in the case where aAliasName cannot be found.

Reimplemented from SCH_IO.

Definition at line 2180 of file sch_io_kicad_legacy.cpp.

References cacheLib(), m_cache, and SCH_IO_LIB_CACHE::m_symbols.

loadSymbol()

SCH_SYMBOL * SCH_IO_KICAD_LEGACY::loadSymbol ( LINE_READER &  aReader )

private

Definition at line 1115 of file sch_io_kicad_legacy.cpp.

References _, ANGLE_HORIZONTAL, ANGLE_VERTICAL, DATASHEET_FIELD, TEMPLATE_FIELDNAME::GetDefaultFieldName(), SCH_FIELD::GetId(), SCH_SHEET::GetScreen(), LINE_READER::GetSource(), SCH_SCREEN::GetUuid(), GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_TOP, LINE_READER::Line(), LINE_READER::LineNumber(), m_appending, m_currentSheet, SCH_SYMBOL_INSTANCE::m_Path, SCH_SYMBOL_INSTANCE::m_Reference, m_rootSheet, SCH_SYMBOL_INSTANCE::m_Unit, m_version, MANDATORY_FIELDS, MAX_UNIT_COUNT_PER_PACKAGE, EDA_IU_SCALE::MilsToIU(), name, LIB_ID::Parse(), parseChar(), parseHex(), parseInt(), parseQuotedString(), parseUnquotedString(), path, LINE_READER::ReadLine(), REFERENCE_FIELD, SCH_PARSE_ERROR, schIUScale, EDA_TEXT::SetBoldFlag(), BASE_SCREEN::SetContentModified(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), LIB_ID::SetLibItemName(), SCH_FIELD::SetName(), SCH_FIELD::SetText(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetVertJustify(), EDA_TEXT::SetVisible(), strCompare(), text, THROW_PARSE_ERROR, VECTOR2< T >::x, TRANSFORM::x1, TRANSFORM::x2, VECTOR2< T >::y, TRANSFORM::y1, and TRANSFORM::y2.

Referenced by LoadContent().

loadText()

SCH_TEXT * SCH_IO_KICAD_LEGACY::loadText ( LINE_READER &  aReader )

private

Definition at line 950 of file sch_io_kicad_legacy.cpp.

References _, ANGLE_HORIZONTAL, ANGLE_VERTICAL, SPIN_STYLE::BOTTOM, ConvertToNewOverbarNotation(), From_UTF8(), GetPenSizeForBold(), GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, SPIN_STYLE::LEFT, LINE_READER::Line(), m_version, EDA_IU_SCALE::MilsToIU(), parseInt(), LINE_READER::ReadLine(), SPIN_STYLE::RIGHT, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_LABEL_T, SCH_PARSE_ERROR, SCH_TEXT_T, schIUScale, SCH_LABEL_BASE::SetShape(), SCH_LABEL_BASE::SetSpinStyle(), sheetLabelNames, strCompare(), text, TYPE_NOT_INIT, SPIN_STYLE::UP, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by LoadContent().

loadWire()

SCH_LINE * SCH_IO_KICAD_LEGACY::loadWire ( LINE_READER &  aReader )

private

Definition at line 781 of file sch_io_kicad_legacy.cpp.

References color, is_eol(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, LINE_READER::Line(), EDA_IU_SCALE::MilsToIU(), parseInt(), parseUnquotedString(), LINE_READER::ReadLine(), SCH_PARSE_ERROR, schIUScale, strCompare(), T_COLOR, T_COLORA, T_STYLE, T_WIDTH, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by LoadContent().

ParsePart()

LIB_SYMBOL * SCH_IO_KICAD_LEGACY::ParsePart ( LINE_READER &  aReader, int  majorVersion = 0, int  minorVersion = 0  )

static

Definition at line 2315 of file sch_io_kicad_legacy.cpp.

References SCH_IO_KICAD_LEGACY_LIB_CACHE::LoadPart().

saveBitmap()

void SCH_IO_KICAD_LEGACY::saveBitmap ( SCH_BITMAP *  aBitmap )

private

Definition at line 1811 of file sch_io_kicad_legacy.cpp.

References SCH_BITMAP::GetImage(), BITMAP_BASE::GetImageData(), SCH_BITMAP::GetPosition(), BITMAP_BASE::GetScale(), image, EDA_IU_SCALE::IUToMils(), m_out, OUTPUTFORMATTER::Print(), schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

saveBusAlias()

void SCH_IO_KICAD_LEGACY::saveBusAlias ( std::shared_ptr< BUS_ALIAS >  aAlias )

private

Definition at line 2085 of file sch_io_kicad_legacy.cpp.

References m_out, OUTPUTFORMATTER::Print(), and TO_UTF8.

Referenced by Format().

saveBusEntry()

void SCH_IO_KICAD_LEGACY::saveBusEntry ( SCH_BUS_ENTRY_BASE *  aBusEntry )

private

Definition at line 1939 of file sch_io_kicad_legacy.cpp.

References SCH_BUS_ENTRY_BASE::GetEnd(), SCH_ITEM::GetLayer(), SCH_BUS_ENTRY_BASE::GetPosition(), EDA_IU_SCALE::IUToMils(), LAYER_WIRE, m_out, OUTPUTFORMATTER::Print(), schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

saveField()

void SCH_IO_KICAD_LEGACY::saveField ( SCH_FIELD *  aField )

private

Definition at line 1775 of file sch_io_kicad_legacy.cpp.

References EscapedUTF8(), EDA_TEXT::GetHorizJustify(), SCH_FIELD::GetId(), SCH_FIELD::GetLibPosition(), SCH_FIELD::GetName(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), 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(), m_out, MANDATORY_FIELDS, OUTPUTFORMATTER::Print(), schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by saveSymbol().

saveJunction()

void SCH_IO_KICAD_LEGACY::saveJunction ( SCH_JUNCTION *  aJunction )

private

Definition at line 1919 of file sch_io_kicad_legacy.cpp.

References SCH_JUNCTION::GetPosition(), EDA_IU_SCALE::IUToMils(), m_out, OUTPUTFORMATTER::Print(), schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

SaveLibrary()

void SCH_IO_KICAD_LEGACY::SaveLibrary ( const wxString &  aLibraryPath, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Reimplemented from SCH_IO.

Definition at line 2270 of file sch_io_kicad_legacy.cpp.

References SCH_IO_LIB_CACHE::GetFileName(), SCH_IO_LIB_CACHE::IsFile(), m_cache, SCH_IO_KICAD_LEGACY_LIB_CACHE::Save(), SCH_IO_LIB_CACHE::SetFileName(), SCH_IO_LIB_CACHE::SetModified(), and writeDocFile().

saveLine()

void SCH_IO_KICAD_LEGACY::saveLine ( SCH_LINE *  aLine )

private

Definition at line 1962 of file sch_io_kicad_legacy.cpp.

References SCH_LINE::GetEndPoint(), SCH_ITEM::GetLayer(), SCH_LINE::GetLineColor(), SCH_LINE::GetLineStyle(), STROKE_PARAMS::GetLineStyleToken(), SCH_LINE::GetLineWidth(), SCH_LINE::GetStartPoint(), SCH_LINE::IsGraphicLine(), EDA_IU_SCALE::IUToMils(), LAYER_BUS, LAYER_WIRE, m_out, OUTPUTFORMATTER::Print(), schIUScale, T_STYLE, T_WIDTH, TO_UTF8, KIGFX::COLOR4D::ToCSSString(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

saveNoConnect()

void SCH_IO_KICAD_LEGACY::saveNoConnect ( SCH_NO_CONNECT *  aNoConnect )

private

Definition at line 1929 of file sch_io_kicad_legacy.cpp.

References SCH_NO_CONNECT::GetPosition(), EDA_IU_SCALE::IUToMils(), m_out, OUTPUTFORMATTER::Print(), schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

SaveSchematicFile()

void SCH_IO_KICAD_LEGACY::SaveSchematicFile ( const wxString &  aFileName, SCH_SHEET *  aSheet, SCHEMATIC *  aSchematic, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Write aSchematic to a storage file in a format that this SCH_IO implementation knows about, or it can be used to write a portion of aSchematic to a special kind of export file.

Parameters

aFileName	is the name of a file to save to on disk.
aSheet	is the class SCH_SHEET in memory document tree from which to extract information when writing to aFileName. The caller continues to own the SCHEMATIC, and the plugin should refrain from modifying the SCHEMATIC if possible.
aSchematic	is the SCHEMATIC object used to access any schematic-wide or project information needed to save the document.
aProperties	is an associative array that can be used to tell the saver how to save the file, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL. Set the #PropSaveCurrentSheetOnly property to only save the current sheet. Otherwise, all hierarchical sheets are saved.

Exceptions

IO_ERROR

if there is a problem saving or exporting.

Reimplemented from SCH_IO.

Definition at line 1500 of file sch_io_kicad_legacy.cpp.

References Format(), SCH_SHEET::GetScreen(), init(), m_out, and SCH_SCREEN::SetFileExists().

saveSheet()

void SCH_IO_KICAD_LEGACY::saveSheet ( SCH_SHEET *  aSheet )

private

Definition at line 1851 of file sch_io_kicad_legacy.cpp.

References KIID::AsLegacyTimestamp(), EscapedUTF8(), SCH_SHEET::GetFields(), SCH_SHEET::GetPins(), SCH_SHEET::GetPosition(), SCH_SHEET::GetSize(), EDA_TEXT::GetText(), EDA_TEXT::GetTextSize(), EDA_IU_SCALE::IUToMils(), m_out, EDA_ITEM::m_Uuid, pin, OUTPUTFORMATTER::Print(), schIUScale, SHEETFILENAME, SHEETNAME, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

SaveSymbol()

void SCH_IO_KICAD_LEGACY::SaveSymbol ( const wxString &  aLibraryPath, const LIB_SYMBOL *  aSymbol, const STRING_UTF8_MAP *  aProperties = nullptr  )

overridevirtual

Write aSymbol to an existing library located at aLibraryPath.

If a LIB_SYMBOL by the same name already exists or there are any conflicting alias names, the new LIB_SYMBOL will silently overwrite any existing aliases and/or part because libraries cannot have duplicate alias names. It is the responsibility of the caller to check the library for conflicts before saving.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several symbols.
aSymbol	is what to store in the library. The library is refreshed and the caller must update any LIB_SYMBOL pointers that may have changed.
aProperties	is an associative array that can be used to tell the saver how to save the symbol, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.

Exceptions

IO_ERROR

if there is a problem saving.

Reimplemented from SCH_IO.

Definition at line 2197 of file sch_io_kicad_legacy.cpp.

References SCH_IO_LIB_CACHE::AddSymbol(), cacheLib(), isBuffering(), m_cache, SCH_IO_KICAD_LEGACY_LIB_CACHE::Save(), and writeDocFile().

saveSymbol()

void SCH_IO_KICAD_LEGACY::saveSymbol ( SCH_SYMBOL *  aSymbol )

private

Definition at line 1669 of file sch_io_kicad_legacy.cpp.

References KIID::AsLegacyTimestamp(), KIID::AsLegacyTimestampString(), LIB_ID::Format(), SCH_ITEM::GetBodyStyle(), SCH_SYMBOL::GetField(), SCH_SYMBOL::GetFieldCount(), SCH_SYMBOL::GetFields(), SCH_SYMBOL::GetInstances(), SCH_SYMBOL::GetLibId(), SCH_SYMBOL::GetPosition(), SCH_SYMBOL::GetPrefix(), EDA_TEXT::GetText(), SCH_SYMBOL::GetTransform(), SCH_ITEM::GetUnit(), EDA_IU_SCALE::IUToMils(), m_out, SCH_SYMBOL_INSTANCE::m_Reference, EDA_ITEM::m_Uuid, MANDATORY_FIELDS, path, OUTPUTFORMATTER::Print(), REFERENCE_FIELD, saveField(), schIUScale, TO_UTF8, toUTFTildaText(), VECTOR2< T >::x, TRANSFORM::x1, TRANSFORM::x2, VECTOR2< T >::y, TRANSFORM::y1, and TRANSFORM::y2.

Referenced by Format().

saveText()

void SCH_IO_KICAD_LEGACY::saveText ( SCH_TEXT *  aText )

private

Definition at line 2004 of file sch_io_kicad_legacy.cpp.

References SCH_ITEM::GetLayer(), SCH_TEXT::GetPosition(), SCH_LABEL_BASE::GetShape(), SCH_LABEL_BASE::GetSpinStyle(), EDA_TEXT::GetText(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetTextWidth(), EDA_TEXT::IsItalic(), EDA_IU_SCALE::IUToMils(), LAYER_GLOBLABEL, LAYER_HIERLABEL, LAYER_LOCLABEL, LAYER_NOTES, m_out, OUTPUTFORMATTER::Print(), schIUScale, sheetLabelNames, text, TO_UTF8, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

SetLibTable()

virtual void SCH_IO::SetLibTable ( SYMBOL_LIB_TABLE *  aTable )

inlinevirtualinherited

Some library plugins need to have access to their parent library table.

Parameters

aTable

is the table this plugin is registered within.

Reimplemented in SCH_IO_DATABASE, and SCH_IO_HTTP_LIB.

Definition at line 346 of file sch_io.h.

SetProgressReporter()

virtual void IO_BASE::SetProgressReporter ( PROGRESS_REPORTER *  aReporter )

inlinevirtualinherited

Set an optional progress reporter.

Reimplemented in SCH_IO_CADSTAR_ARCHIVE.

Definition at line 81 of file io_base.h.

References IO_BASE::m_progressReporter.

Referenced by PCB_CONTROL::AppendBoard().

SetReporter()

virtual void IO_BASE::SetReporter ( REPORTER *  aReporter )

inlinevirtualinherited

Set an optional reporter for warnings/errors.

Reimplemented in SCH_IO_CADSTAR_ARCHIVE.

Definition at line 76 of file io_base.h.

References IO_BASE::m_reporter.

SupportsSubLibraries()

virtual bool SCH_IO::SupportsSubLibraries ( ) const

inlinevirtualinherited

Returns

true if this plugin supports libraries that contain sub-libraries.

Reimplemented in SCH_IO_DATABASE, and SCH_IO_HTTP_LIB.

Definition at line 288 of file sch_io.h.

writeDocFile()

bool SCH_IO_KICAD_LEGACY::writeDocFile ( const STRING_UTF8_MAP *  aProperties )

private

Definition at line 2111 of file sch_io_kicad_legacy.cpp.

References PropNoDocFile.

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

Member Data Documentation

m_appending

bool SCH_IO_KICAD_LEGACY::m_appending

protected

Definition at line 180 of file sch_io_kicad_legacy.h.

Referenced by LoadSchematicFile(), and loadSymbol().

m_cache

SCH_IO_KICAD_LEGACY_LIB_CACHE* SCH_IO_KICAD_LEGACY::m_cache

protected

Definition at line 193 of file sch_io_kicad_legacy.h.

Referenced by cacheLib(), CreateLibrary(), DeleteLibrary(), DeleteSymbol(), EnumerateSymbolLib(), GetModifyHash(), init(), LoadSymbol(), SaveLibrary(), SaveSymbol(), and ~SCH_IO_KICAD_LEGACY().

m_currentPath

std::stack<wxString> SCH_IO_KICAD_LEGACY::m_currentPath

protected

Stack to maintain nested sheet paths.

Definition at line 189 of file sch_io_kicad_legacy.h.

Referenced by loadHierarchy(), and LoadSchematicFile().

m_currentSheet

SCH_SHEET* SCH_IO_KICAD_LEGACY::m_currentSheet

protected

The sheet currently being loaded.

Definition at line 191 of file sch_io_kicad_legacy.h.

Referenced by init(), loadHierarchy(), and loadSymbol().

m_error

wxString SCH_IO_KICAD_LEGACY::m_error

protected

For throwing exceptions or errors on partial schematic loads.

Definition at line 182 of file sch_io_kicad_legacy.h.

Referenced by GetError(), loadHeader(), and loadHierarchy().

m_lastProgressLine

unsigned SCH_IO_KICAD_LEGACY::m_lastProgressLine

protected

Definition at line 185 of file sch_io_kicad_legacy.h.

Referenced by checkpoint().

m_lineCount

unsigned SCH_IO_KICAD_LEGACY::m_lineCount

protected

for progress reporting

Definition at line 186 of file sch_io_kicad_legacy.h.

Referenced by checkpoint(), and loadFile().

m_lineReader

LINE_READER* SCH_IO_KICAD_LEGACY::m_lineReader

protected

for progress reporting

Definition at line 184 of file sch_io_kicad_legacy.h.

Referenced by checkpoint(), and loadFile().

m_name

wxString IO_BASE::m_name

protectedinherited

Name of the IO loader.

Definition at line 207 of file io_base.h.

Referenced by IO_BASE::GetName().

m_out

OUTPUTFORMATTER* SCH_IO_KICAD_LEGACY::m_out

protected

The formatter for saving SCH_SCREEN objects.

Definition at line 192 of file sch_io_kicad_legacy.h.

Referenced by Format(), init(), saveBitmap(), saveBusAlias(), saveBusEntry(), saveField(), saveJunction(), saveLine(), saveNoConnect(), SaveSchematicFile(), saveSheet(), saveSymbol(), and saveText().

m_path

wxString SCH_IO_KICAD_LEGACY::m_path

protected

Root project path for loading child sheets.

Definition at line 188 of file sch_io_kicad_legacy.h.

Referenced by LoadSchematicFile().

m_progressReporter

PROGRESS_REPORTER* IO_BASE::m_progressReporter

protectedinherited

Progress reporter to track the progress of the operation, may be nullptr.

Definition at line 213 of file io_base.h.

Referenced by SCH_IO_EAGLE::checkpoint(), checkpoint(), SCH_IO_EAGLE::ensureLoadedLibrary(), SCH_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary(), PCB_IO_IPC2581::generateAvlSection(), PCB_IO_IPC2581::generateBOMSection(), PCB_IO_IPC2581::generateContentSection(), PCB_IO_IPC2581::generateEcadSection(), PCB_IO_IPC2581::generateHistorySection(), PCB_IO_ALTIUM_CIRCUIT_STUDIO::LoadBoard(), PCB_IO_ALTIUM_CIRCUIT_MAKER::LoadBoard(), PCB_IO_ALTIUM_DESIGNER::LoadBoard(), PCB_IO_SOLIDWORKS::LoadBoard(), PCB_IO_CADSTAR_ARCHIVE::LoadBoard(), PCB_IO_EASYEDA::LoadBoard(), PCB_IO_EASYEDAPRO::LoadBoard(), PCB_IO_FABMASTER::LoadBoard(), PCB_IO_KICAD_SEXPR::LoadBoard(), loadFile(), SCH_IO_KICAD_SEXPR::loadFile(), SCH_IO_EAGLE::loadSchematic(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EAGLE::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), PCB_IO_IPC2581::SaveBoard(), IO_BASE::SetProgressReporter(), and SCH_IO_CADSTAR_ARCHIVE::SetProgressReporter().

m_reporter

REPORTER* IO_BASE::m_reporter

protectedinherited

Reporter to log errors/warnings to, may be nullptr.

Definition at line 210 of file io_base.h.

Referenced by SCH_IO_ALTIUM::AddLibTextBox(), SCH_IO_CADSTAR_ARCHIVE::ensureLoadedLibrary(), SCH_IO_EAGLE::loadInstance(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), SCH_IO_ALTIUM::ParseAltiumSch(), SCH_IO_ALTIUM::ParseArc(), SCH_IO_ALTIUM::ParseBezier(), SCH_IO_ALTIUM::ParseCircle(), SCH_IO_ALTIUM::ParseComponent(), SCH_IO_ALTIUM::ParseDesignator(), SCH_IO_ALTIUM::ParseEllipse(), SCH_IO_ALTIUM::ParseEllipticalArc(), SCH_IO_ALTIUM::ParseFileName(), SCH_IO_ALTIUM::ParseHarnessConnector(), SCH_IO_ALTIUM::ParseHarnessEntry(), SCH_IO_ALTIUM::ParseHarnessPort(), SCH_IO_ALTIUM::ParseHarnessType(), SCH_IO_ALTIUM::ParseImage(), SCH_IO_ALTIUM::ParseImplementation(), SCH_IO_ALTIUM::ParseLabel(), SCH_IO_ALTIUM::ParseLibFile(), SCH_IO_ALTIUM::ParseLine(), SCH_IO_ALTIUM::ParsePin(), SCH_IO_ALTIUM::ParsePolygon(), SCH_IO_ALTIUM::ParsePolyline(), SCH_IO_ALTIUM::ParsePort(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_IO_ALTIUM::ParseRecord(), SCH_IO_ALTIUM::ParseRectangle(), SCH_IO_ALTIUM::ParseRoundRectangle(), SCH_IO_ALTIUM::ParseSheetEntry(), SCH_IO_ALTIUM::ParseSheetName(), SCH_IO_ALTIUM::ParseSignalHarness(), SCH_IO_ALTIUM::ParseStorage(), SCH_IO_ALTIUM::SCH_IO_ALTIUM(), SCH_IO_CADSTAR_ARCHIVE::SCH_IO_CADSTAR_ARCHIVE(), SCH_IO_EAGLE::SCH_IO_EAGLE(), SCH_IO_EASYEDA::SCH_IO_EASYEDA(), SCH_IO_EASYEDAPRO::SCH_IO_EASYEDAPRO(), SCH_IO_LTSPICE::SCH_IO_LTSPICE(), IO_BASE::SetReporter(), and SCH_IO_CADSTAR_ARCHIVE::SetReporter().

m_rootSheet

SCH_SHEET* SCH_IO_KICAD_LEGACY::m_rootSheet

protected

The root sheet of the schematic being loaded.

Definition at line 190 of file sch_io_kicad_legacy.h.

Referenced by init(), LoadContent(), loadHierarchy(), LoadSchematicFile(), and loadSymbol().

m_schematic

SCHEMATIC* SCH_IO_KICAD_LEGACY::m_schematic

protected

Definition at line 194 of file sch_io_kicad_legacy.h.

Referenced by Format(), init(), and loadHierarchy().

m_version

int SCH_IO_KICAD_LEGACY::m_version

protected

Version of file being loaded.

Indicate if we are appending the loaded schemitic or loading a full project.

Definition at line 177 of file sch_io_kicad_legacy.h.

Referenced by init(), LoadContent(), loadFile(), loadHeader(), loadSymbol(), and loadText().

PropBuffering

const char * SCH_IO_KICAD_LEGACY::PropBuffering = "buffering"

static

The property used internally by the plugin to enable cache buffering which prevents the library file from being written every time the cache is changed.

This is useful when writing the schematic cache library file or saving a library to a new file name.

Definition at line 94 of file sch_io_kicad_legacy.h.

Referenced by SYMBOL_LIB::EnableBuffering(), SYMBOL_LIB::IsBuffering(), isBuffering(), SCH_IO_EAGLE::LoadSchematicFile(), SYMBOL_LIB_TABLE_RESCUER::OpenRescueLibrary(), LIB_BUFFER::SaveBuffer(), and SYMBOL_LIBRARY_MANAGER::SaveLibrary().

PropNoDocFile

const char * SCH_IO_KICAD_LEGACY::PropNoDocFile = "no_doc_file"

static

The property used internally by the plugin to disable writing the library documentation (.dcm) file when saving the library cache.

Definition at line 100 of file sch_io_kicad_legacy.h.

Referenced by SYMBOL_LIB::IsCache(), SYMBOL_LIB::Save(), SYMBOL_LIB::SetCache(), and writeDocFile().

---

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

• sch_io_kicad_legacy.h
• sch_io_kicad_legacy.cpp