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

#include <sch_io_kicad_sexpr.h>

Inheritance diagram for SCH_IO_KICAD_SEXPR:

Public Member Functions
	SCH_IO_KICAD_SEXPR ()

virtual	~SCH_IO_KICAD_SEXPR ()

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.

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_SHEET *aSheet, int aVersion=SEXPR_SCHEMATIC_FILE_VERSION)

void	SaveSchematicFile (const wxString &aFileName, SCH_SHEET aSheet, 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 (EE_SELECTION aSelection, SCH_SHEET_PATH aSelectionPath, SCHEMATIC &aSchematic, OUTPUTFORMATTER *aFormatter, bool aForClipboard)

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.

void	GetAvailableSymbolFields (std::vector< wxString > &aNames) override
	Retrieves a list of (custom) field names that are present on symbols in this library.

void	GetDefaultSymbolFields (std::vector< wxString > &aNames) override
	Retrieves a list of (custom) field names that should be shown by default for this library in the symbol chooser.

const wxString &	GetError () const override
	Return an error string to the caller.

virtual bool	CanReadSchematicFile (const wxString &aFileName) const
	Checks if this SCH_IO can read the specified schematic file.

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	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.

virtual bool	CanReadLibrary (const wxString &aFileName) const
	Checks if this IO object can read the specified library file/directory.

Static Public Member Functions
static std::vector< LIB_SYMBOL * >	ParseLibSymbols (std::string &aSymbolText, std::string aSource, int aFileVersion=SEXPR_SCHEMATIC_FILE_VERSION)

static void	FormatLibSymbol (LIB_SYMBOL *aPart, 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.

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.

int	m_nextFreeFieldId

bool	m_appending
	Schematic load append status.

wxString	m_error
	For throwing exceptions or errors on partial loads.

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_PATH	m_currentSheetPath

SCHEMATIC *	m_schematic

OUTPUTFORMATTER *	m_out
	The formatter for saving SCH_SCREEN objects.

SCH_IO_KICAD_SEXPR_LIB_CACHE *	m_cache

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	loadHierarchy (const SCH_SHEET_PATH &aParentSheetPath, SCH_SHEET *aSheet)

void	loadFile (const wxString &aFileName, SCH_SHEET *aSheet)

void	saveSymbol (SCH_SYMBOL aSymbol, const SCHEMATIC &aSchematic, int aNestLevel, bool aForClipboard, const SCH_SHEET_PATH aRelativePath=nullptr)

void	saveField (SCH_FIELD *aField, int aNestLevel)

void	saveBitmap (SCH_BITMAP *aBitmap, int aNestLevel)

void	saveSheet (SCH_SHEET *aSheet, int aNestLevel)

void	saveJunction (SCH_JUNCTION *aJunction, int aNestLevel)

void	saveNoConnect (SCH_NO_CONNECT *aNoConnect, int aNestLevel)

void	saveBusEntry (SCH_BUS_ENTRY_BASE *aBusEntry, int aNestLevel)

void	saveLine (SCH_LINE *aLine, int aNestLevel)

void	saveShape (SCH_SHAPE *aShape, int aNestLevel)

void	saveRuleArea (SCH_RULE_AREA *aRuleArea, int aNestLevel)

void	saveText (SCH_TEXT *aText, int aNestLevel)

void	saveTextBox (SCH_TEXTBOX *aText, int aNestLevel)

void	saveTable (SCH_TABLE *aTable, int aNestLevel)

void	saveBusAlias (std::shared_ptr< BUS_ALIAS > aAlias, int aNestLevel)

void	saveInstances (const std::vector< SCH_SHEET_INSTANCE > &aSheets, int aNestLevel)

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

bool	isBuffering (const STRING_UTF8_MAP *aProperties)

Detailed Description

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

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

Definition at line 67 of file sch_io_kicad_sexpr.h.

Constructor & Destructor Documentation

◆ SCH_IO_KICAD_SEXPR()

SCH_IO_KICAD_SEXPR::SCH_IO_KICAD_SEXPR ( )

Definition at line 75 of file sch_io_kicad_sexpr.cpp.

References init().

◆ ~SCH_IO_KICAD_SEXPR()

SCH_IO_KICAD_SEXPR::~SCH_IO_KICAD_SEXPR ( )

virtual

Definition at line 81 of file sch_io_kicad_sexpr.cpp.

References m_cache.

Member Function Documentation

◆ cacheLib()

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

private

Definition at line 1580 of file sch_io_kicad_sexpr.cpp.

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

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

◆ CanReadLibrary()

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

virtualinherited

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 in SCH_IO_ALTIUM, SCH_IO_CADSTAR_ARCHIVE, SCH_IO_EAGLE, SCH_IO_EASYEDA, SCH_IO_KICAD_LEGACY, PCB_IO_ALTIUM_DESIGNER, PCB_IO_CADSTAR_ARCHIVE, PCB_IO_EAGLE, PCB_IO_EASYEDA, and PCB_IO_IPC2581.

Definition at line 67 of file io_base.cpp.

References IO_BASE::GetLibraryDesc(), IO_BASE::IO_FILE_DESC::m_ExtensionsInDir, IO_BASE::IO_FILE_DESC::m_FileExtensions, and IO_BASE::IO_FILE_DESC::m_IsFile.

Referenced by SCH_IO_ALTIUM::CanReadLibrary(), SCH_IO_CADSTAR_ARCHIVE::CanReadLibrary(), SCH_IO_EAGLE::CanReadLibrary(), SCH_IO_KICAD_LEGACY::CanReadLibrary(), PCB_IO_ALTIUM_DESIGNER::CanReadLibrary(), PCB_IO_CADSTAR_ARCHIVE::CanReadLibrary(), and PCB_IO_EAGLE::CanReadLibrary().

◆ CanReadSchematicFile()

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

virtualinherited

Checks if this SCH_IO can read the specified schematic file.

If not overriden, extension check is used.

Reimplemented in SCH_IO_ALTIUM, SCH_IO_EAGLE, SCH_IO_EASYEDA, SCH_IO_EASYEDAPRO, and SCH_IO_KICAD_LEGACY.

Definition at line 46 of file sch_io.cpp.

References SCH_IO::GetSchematicFileDesc(), and IO_BASE::IO_FILE_DESC::m_FileExtensions.

Referenced by SCH_IO_ALTIUM::CanReadSchematicFile(), SCH_IO_EAGLE::CanReadSchematicFile(), SCH_IO_EASYEDA::CanReadSchematicFile(), and SCH_IO_KICAD_LEGACY::CanReadSchematicFile().

◆ CreateLibrary()

void SCH_IO_KICAD_SEXPR::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 1709 of file sch_io_kicad_sexpr.cpp.

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

◆ DeleteLibrary()

bool SCH_IO_KICAD_SEXPR::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 1728 of file sch_io_kicad_sexpr.cpp.

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

◆ DeleteSymbol()

void SCH_IO_KICAD_SEXPR::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 1695 of file sch_io_kicad_sexpr.cpp.

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

◆ EnumerateSymbolLib() [1/2]

void SCH_IO_KICAD_SEXPR::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 1632 of file sch_io_kicad_sexpr.cpp.

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

◆ EnumerateSymbolLib() [2/2]

void SCH_IO_KICAD_SEXPR::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 1611 of file sch_io_kicad_sexpr.cpp.

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

◆ Format() [1/2]

void SCH_IO_KICAD_SEXPR::Format	(	EE_SELECTION *	aSelection,
		SCH_SHEET_PATH *	aSelectionPath,
		SCHEMATIC &	aSchematic,
		OUTPUTFORMATTER *	aFormatter,
		bool	aForClipboard
	)

Definition at line 512 of file sch_io_kicad_sexpr.cpp.

References EDA_ITEM::ClearFlags(), LIB_ID::Format(), SELECTION::GetItem(), SCH_SYMBOL::GetLibId(), SCH_SCREEN::GetLibSymbols(), EDA_ITEM::GetParent(), SCH_SYMBOL::GetSchSymbolLibraryName(), EE_SELECTION::GetScreen(), SCHEMATIC::GetSheets(), SELECTION::GetSize(), m_out, m_schematic, OUTPUTFORMATTER::Print(), saveBitmap(), saveBusEntry(), saveJunction(), saveLine(), saveNoConnect(), saveRuleArea(), saveShape(), saveSheet(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), saveSymbol(), saveTable(), saveText(), saveTextBox(), SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_RULE_AREA_T, SCH_SHAPE_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TABLE_T, SCH_TABLECELL_T, SCH_TEXT_T, SCH_TEXTBOX_T, EDA_ITEM::SetFlags(), SKIP_STRUCT, EDA_ITEM::Type(), SCH_SYMBOL::UseLibIdLookup(), and UTF8::wx_str().

◆ Format() [2/2]

void SCH_IO_KICAD_SEXPR::Format ( SCH_SHEET * aSheet )

Definition at line 360 of file sch_io_kicad_sexpr.cpp.

References PAGE_INFO::Format(), TITLE_BLOCK::Format(), KICAD_FORMAT::FormatUuid(), SCH_SCREEN::GetBusAliases(), SCH_SCREEN::GetLibSymbols(), GetMajorMinorVersion(), SCH_SCREEN::GetPageSettings(), SCH_SHEET::GetRootInstance(), SCH_SHEET::GetScreen(), SCH_SCREEN::GetTitleBlock(), SCH_SHEET::HasRootInstance(), SCH_SCREEN::Items(), m_out, m_schematic, SCH_SCREEN::m_uuid, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), saveBitmap(), saveBusAlias(), saveBusEntry(), saveInstances(), saveJunction(), saveLine(), saveNoConnect(), saveRuleArea(), saveShape(), saveSheet(), SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol(), saveSymbol(), saveTable(), saveText(), saveTextBox(), SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_DIRECTIVE_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LAYER_ID_START, SCH_LINE_T, SCH_MARKER_T, SCH_NO_CONNECT_T, SCH_RULE_AREA_T, SCH_SHAPE_T, SCH_SHEET_T, SCH_SYMBOL_T, SCH_TABLE_T, SCH_TEXT_T, SCH_TEXTBOX_T, SEXPR_SCHEMATIC_FILE_VERSION, EDA_ITEM::Type(), and TYPE_NOT_INIT.

Referenced by SCH_EDITOR_CONTROL::doCopy(), and SaveSchematicFile().

◆ FormatLibSymbol()

void SCH_IO_KICAD_SEXPR::FormatLibSymbol	(	LIB_SYMBOL *	aPart,
		OUTPUTFORMATTER &	aFormatter
	)

static

Definition at line 1846 of file sch_io_kicad_sexpr.cpp.

References SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol().

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Copy(), and SYMBOL_EDIT_FRAME::CopySymbolToClipboard().

◆ GetAvailableSymbolFields()

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

overridevirtual

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 from SCH_IO.

Definition at line 1782 of file sch_io_kicad_sexpr.cpp.

References m_cache, and SCH_IO_LIB_CACHE::m_symbols.

Referenced by GetDefaultSymbolFields().

◆ GetDefaultSymbolFields()

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

overridevirtual

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 from SCH_IO.

Definition at line 1811 of file sch_io_kicad_sexpr.cpp.

References GetAvailableSymbolFields().

◆ GetError()

const wxString & SCH_IO_KICAD_SEXPR::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 134 of file sch_io_kicad_sexpr.h.

References m_error.

◆ GetLibraryDesc()

const IO_BASE::IO_FILE_DESC SCH_IO_KICAD_SEXPR::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 80 of file sch_io_kicad_sexpr.h.

References _HKI, and FILEEXT::KiCadSymbolLibFileExtension.

◆ 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_SEXPR::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 1601 of file sch_io_kicad_sexpr.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_SEXPR::GetSchematicFileDesc ( ) const

inlineoverridevirtual

Returns schematic file description for the SCH_IO.

Reimplemented from SCH_IO.

Definition at line 74 of file sch_io_kicad_sexpr.h.

References _HKI, and FILEEXT::KiCadSchematicFileExtension.

◆ 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_SEXPR::init	(	SCHEMATIC *	aSchematic,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

protected

initialize PLUGIN like a constructor would.

Definition at line 87 of file sch_io_kicad_sexpr.cpp.

References m_appending, m_cache, m_nextFreeFieldId, m_out, m_rootSheet, m_schematic, and m_version.

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

◆ isBuffering()

bool SCH_IO_KICAD_SEXPR::isBuffering ( const STRING_UTF8_MAP * aProperties )

private

Definition at line 1595 of file sch_io_kicad_sexpr.cpp.

References STRING_UTF8_MAP::Exists(), and PropBuffering.

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

◆ IsLibraryWritable()

bool SCH_IO_KICAD_SEXPR::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 1774 of file sch_io_kicad_sexpr.cpp.

◆ LoadContent()

void SCH_IO_KICAD_SEXPR::LoadContent	(	LINE_READER &	aReader,
		SCH_SHEET *	aSheet,
		int	aVersion = `SEXPR_SCHEMATIC_FILE_VERSION`
	)

Definition at line 321 of file sch_io_kicad_sexpr.cpp.

References SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic().

Referenced by SCH_EDITOR_CONTROL::Paste().

◆ loadFile()

void SCH_IO_KICAD_SEXPR::loadFile	(	const wxString &	aFileName,
		SCH_SHEET *	aSheet
	)

private

Definition at line 295 of file sch_io_kicad_sexpr.cpp.

References _, PROGRESS_REPORTER::KeepRefreshing(), m_appending, IO_BASE::m_progressReporter, m_rootSheet, SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic(), FILE_LINE_READER::ReadLine(), PROGRESS_REPORTER::Report(), FILE_LINE_READER::Rewind(), and THROW_IO_ERROR.

Referenced by loadHierarchy().

◆ loadHierarchy()

void SCH_IO_KICAD_SEXPR::loadHierarchy	(	const SCH_SHEET_PATH &	aParentSheetPath,
		SCH_SHEET *	aSheet
	)

private

◆ LoadSchematicFile()

SCH_SHEET * SCH_IO_KICAD_SEXPR::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 99 of file sch_io_kicad_sexpr.cpp.

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

◆ LoadSymbol()

LIB_SYMBOL * SCH_IO_KICAD_SEXPR::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 1653 of file sch_io_kicad_sexpr.cpp.

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

◆ ParseLibSymbols()

std::vector< LIB_SYMBOL * > SCH_IO_KICAD_SEXPR::ParseLibSymbols	(	std::string &	aSymbolText,
		std::string	aSource,
		int	aFileVersion = `SEXPR_SCHEMATIC_FILE_VERSION`
	)

static

Definition at line 1817 of file sch_io_kicad_sexpr.cpp.

References SCH_IO_KICAD_SEXPR_PARSER::ParseSymbol().

Referenced by SYMBOL_EDIT_FRAME::DuplicateSymbol(), and SYMBOL_EDITOR_EDIT_TOOL::Paste().

◆ saveBitmap()

void SCH_IO_KICAD_SEXPR::saveBitmap	(	SCH_BITMAP *	aBitmap,
		int	aNestLevel
	)

private

Definition at line 947 of file sch_io_kicad_sexpr.cpp.

References EDA_UNIT_UTILS::FormatInternalUnits(), KICAD_FORMAT::FormatUuid(), SCH_BITMAP::GetImage(), BITMAP_BASE::GetImageData(), BITMAP_BASE::GetImageDataBuffer(), SCH_BITMAP::GetPosition(), BITMAP_BASE::GetPPI(), BITMAP_BASE::GetScale(), image, m_out, EDA_ITEM::m_Uuid, MIME_BASE64_LENGTH, OUTPUTFORMATTER::Print(), scale, schIUScale, SEXPR_SCHEMATIC_FILE_VERSION, TO_UTF8, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

◆ saveBusAlias()

void SCH_IO_KICAD_SEXPR::saveBusAlias	(	std::shared_ptr< BUS_ALIAS >	aAlias,
		int	aNestLevel
	)

private

Definition at line 1535 of file sch_io_kicad_sexpr.cpp.

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

Referenced by Format().

◆ saveBusEntry()

void SCH_IO_KICAD_SEXPR::saveBusEntry	(	SCH_BUS_ENTRY_BASE *	aBusEntry,
		int	aNestLevel
	)

private

◆ saveField()

void SCH_IO_KICAD_SEXPR::saveField	(	SCH_FIELD *	aField,
		int	aNestLevel
	)

private

◆ saveInstances()

void SCH_IO_KICAD_SEXPR::saveInstances	(	const std::vector< SCH_SHEET_INSTANCE > &	aSheets,
		int	aNestLevel
	)

private

Definition at line 1555 of file sch_io_kicad_sexpr.cpp.

References m_out, path, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

Referenced by Format().

◆ saveJunction()

void SCH_IO_KICAD_SEXPR::saveJunction	(	SCH_JUNCTION *	aJunction,
		int	aNestLevel
	)

private

Definition at line 1138 of file sch_io_kicad_sexpr.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, FormatDouble2Str(), EDA_UNIT_UTILS::FormatInternalUnits(), KICAD_FORMAT::FormatUuid(), KIGFX::COLOR4D::g, SCH_JUNCTION::GetColor(), SCH_JUNCTION::GetDiameter(), SCH_JUNCTION::GetPosition(), KiROUND(), m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), KIGFX::COLOR4D::r, schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

◆ SaveLibrary()

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

overridevirtual

Reimplemented from SCH_IO.

Definition at line 1754 of file sch_io_kicad_sexpr.cpp.

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

◆ saveLine()

void SCH_IO_KICAD_SEXPR::saveLine	(	SCH_LINE *	aLine,
		int	aNestLevel
	)

private

Definition at line 1256 of file sch_io_kicad_sexpr.cpp.

References STROKE_PARAMS::Format(), EDA_UNIT_UTILS::FormatInternalUnits(), KICAD_FORMAT::FormatUuid(), SCH_LINE::GetEndPoint(), SCH_ITEM::GetLayer(), SCH_LINE::GetStartPoint(), SCH_LINE::GetStroke(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, LayerName(), m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), schIUScale, TO_UTF8, UNIMPLEMENTED_FOR, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format(), and saveBusEntry().

◆ saveNoConnect()

void SCH_IO_KICAD_SEXPR::saveNoConnect	(	SCH_NO_CONNECT *	aNoConnect,
		int	aNestLevel
	)

private

Definition at line 1160 of file sch_io_kicad_sexpr.cpp.

References EDA_UNIT_UTILS::FormatInternalUnits(), KICAD_FORMAT::FormatUuid(), SCH_NO_CONNECT::GetPosition(), m_out, EDA_ITEM::m_Uuid, OUTPUTFORMATTER::Print(), schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

◆ saveRuleArea()

void SCH_IO_KICAD_SEXPR::saveRuleArea	(	SCH_RULE_AREA *	aRuleArea,
		int	aNestLevel
	)

private

Definition at line 1246 of file sch_io_kicad_sexpr.cpp.

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

Referenced by Format().

◆ SaveSchematicFile()

void SCH_IO_KICAD_SEXPR::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 332 of file sch_io_kicad_sexpr.cpp.

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

Referenced by KI_TEST::DumpSchematicToFile().

◆ saveShape()

void SCH_IO_KICAD_SEXPR::saveShape	(	SCH_SHAPE *	aShape,
		int	aNestLevel
	)

private

Definition at line 1209 of file sch_io_kicad_sexpr.cpp.

References formatArc(), formatBezier(), formatCircle(), formatPoly(), formatRect(), EDA_SHAPE::GetFillColor(), EDA_SHAPE::GetFillMode(), EDA_SHAPE::GetShape(), SCH_SHAPE::GetStroke(), m_out, EDA_ITEM::m_Uuid, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by Format(), and saveRuleArea().

◆ saveSheet()

void SCH_IO_KICAD_SEXPR::saveSheet	(	SCH_SHEET *	aSheet,
		int	aNestLevel
	)

private

Definition at line 1001 of file sch_io_kicad_sexpr.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, EscapedUTF8(), FIELDS_AUTOPLACED_NO, STROKE_PARAMS::Format(), EDA_UNIT_UTILS::FormatAngle(), EDA_UNIT_UTILS::FormatInternalUnits(), KICAD_FORMAT::FormatUuid(), KIGFX::COLOR4D::g, SCH_SHEET::GetBackgroundColor(), SCH_SHEET::GetBorderColor(), SCH_SHEET::GetBorderWidth(), SCH_SHEET::GetFields(), SCH_ITEM::GetFieldsAutoplaced(), SCH_SHEET::GetInstances(), SCH_SHEET::GetPins(), SCH_SHEET::GetPosition(), PROJECT::GetProjectName(), SCH_SHEET_LIST::GetSheetPathByKIIDPath(), getSheetPinAngle(), getSheetPinShapeToken(), SCHEMATIC::GetSheets(), SCH_SHEET::GetSize(), KiROUND(), m_nextFreeFieldId, m_out, m_schematic, EDA_ITEM::m_Uuid, path, pin, OUTPUTFORMATTER::Print(), SCHEMATIC::Prj(), OUTPUTFORMATTER::Quotew(), KIGFX::COLOR4D::r, SCHEMATIC::Root(), saveField(), schIUScale, STROKE_PARAMS::SetWidth(), SHEET_MANDATORY_FIELDS, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

◆ SaveSymbol()

void SCH_IO_KICAD_SEXPR::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 1681 of file sch_io_kicad_sexpr.cpp.

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

◆ saveSymbol()

void SCH_IO_KICAD_SEXPR::saveSymbol	(	SCH_SYMBOL *	aSymbol,
		const SCHEMATIC &	aSchematic,
		int	aNestLevel,
		bool	aForClipboard,
		const SCH_SHEET_PATH *	aRelativePath = `nullptr`
	)

private

Definition at line 649 of file sch_io_kicad_sexpr.cpp.

References ANGLE_0, ANGLE_180, ANGLE_270, ANGLE_90, KIID_PATH::AsString(), FIELDS_AUTOPLACED_NO, FOOTPRINT_FIELD, LIB_ID::Format(), EDA_UNIT_UTILS::FormatAngle(), EDA_UNIT_UTILS::FormatInternalUnits(), KICAD_FORMAT::FormatUuid(), SCH_ITEM::GetBodyStyle(), SYMBOL::GetDNP(), SYMBOL::GetExcludedFromBoard(), SYMBOL::GetExcludedFromBOM(), SYMBOL::GetExcludedFromSim(), SCH_SYMBOL::GetField(), SCH_SYMBOL::GetFields(), SCH_ITEM::GetFieldsAutoplaced(), SCH_SYMBOL::GetInstance(), SCH_SYMBOL::GetInstances(), SCH_SYMBOL::GetLibId(), SCH_SYMBOL::GetOrientation(), SCH_SYMBOL::GetPosition(), SCH_SYMBOL::GetRawPins(), SCH_SYMBOL::GetSchSymbolLibraryName(), SCH_SHEET_LIST::GetSheetPathByKIIDPath(), SCHEMATIC::GetSheets(), EDA_TEXT::GetText(), SCH_ITEM::GetUnit(), m_nextFreeFieldId, m_out, SCH_SYMBOL_INSTANCE::m_Reference, SCH_SYMBOL_INSTANCE::m_Unit, EDA_ITEM::m_Uuid, KIID_PATH::MakeRelativeTo(), MANDATORY_FIELDS, SCH_SHEET_PATH::Path(), path, pin, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), REFERENCE_FIELD, SCHEMATIC::Root(), saveField(), schIUScale, SYM_MIRROR_X, SYM_MIRROR_Y, SYM_ORIENT_180, SYM_ORIENT_270, SYM_ORIENT_90, toUTFTildaText(), SCH_SYMBOL::UseLibIdLookup(), VALUE_FIELD, UTF8::wx_str(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Format().

◆ saveTable()

void SCH_IO_KICAD_SEXPR::saveTable	(	SCH_TABLE *	aTable,
		int	aNestLevel
	)

private

◆ saveText()

void SCH_IO_KICAD_SEXPR::saveText	(	SCH_TEXT *	aText,
		int	aNestLevel
	)

private

◆ saveTextBox()

void SCH_IO_KICAD_SEXPR::saveTextBox	(	SCH_TEXTBOX *	aText,
		int	aNestLevel
	)

private

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

Member Data Documentation

◆ m_appending

bool SCH_IO_KICAD_SEXPR::m_appending

protected

Schematic load append status.

Definition at line 168 of file sch_io_kicad_sexpr.h.

Referenced by init(), loadFile(), and LoadSchematicFile().

◆ m_cache

SCH_IO_KICAD_SEXPR_LIB_CACHE* SCH_IO_KICAD_SEXPR::m_cache

protected

Definition at line 178 of file sch_io_kicad_sexpr.h.

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

◆ m_currentPath

std::stack<wxString> SCH_IO_KICAD_SEXPR::m_currentPath

protected

Stack to maintain nested sheet paths.

Definition at line 173 of file sch_io_kicad_sexpr.h.

Referenced by loadHierarchy(), and LoadSchematicFile().

◆ m_currentSheetPath

SCH_SHEET_PATH SCH_IO_KICAD_SEXPR::m_currentSheetPath

protected

Definition at line 175 of file sch_io_kicad_sexpr.h.

Referenced by loadHierarchy().

◆ m_error

wxString SCH_IO_KICAD_SEXPR::m_error

protected

For throwing exceptions or errors on partial loads.

Definition at line 169 of file sch_io_kicad_sexpr.h.

Referenced by GetError(), and loadHierarchy().

◆ 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_nextFreeFieldId

int SCH_IO_KICAD_SEXPR::m_nextFreeFieldId

protected

Definition at line 167 of file sch_io_kicad_sexpr.h.

Referenced by init(), saveField(), saveSheet(), and saveSymbol().

◆ m_out

OUTPUTFORMATTER* SCH_IO_KICAD_SEXPR::m_out

protected

The formatter for saving SCH_SCREEN objects.

Definition at line 177 of file sch_io_kicad_sexpr.h.

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

◆ m_path

wxString SCH_IO_KICAD_SEXPR::m_path

protected

Root project path for loading child sheets.

Definition at line 172 of file sch_io_kicad_sexpr.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(), SCH_IO_KICAD_LEGACY::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(), SCH_IO_KICAD_LEGACY::loadFile(), 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.

◆ m_rootSheet

SCH_SHEET* SCH_IO_KICAD_SEXPR::m_rootSheet

protected

The root sheet of the schematic being loaded.

Definition at line 174 of file sch_io_kicad_sexpr.h.

Referenced by init(), loadFile(), loadHierarchy(), and LoadSchematicFile().

◆ m_schematic

SCHEMATIC* SCH_IO_KICAD_SEXPR::m_schematic

protected

Definition at line 176 of file sch_io_kicad_sexpr.h.

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

◆ m_version

int SCH_IO_KICAD_SEXPR::m_version

protected

Version of file being loaded.

Definition at line 166 of file sch_io_kicad_sexpr.h.

Referenced by init().

◆ PropBuffering

const char * SCH_IO_KICAD_SEXPR::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 91 of file sch_io_kicad_sexpr.h.

Referenced by isBuffering(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), and SCH_IO_EASYEDAPRO::LoadSchematicFile().

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SCH_IO_KICAD_SEXPR()

◆ ~SCH_IO_KICAD_SEXPR()

Member Function Documentation

◆ cacheLib()

◆ CanReadLibrary()

◆ CanReadSchematicFile()

◆ CreateLibrary()

◆ DeleteLibrary()

◆ DeleteSymbol()

◆ EnumerateSymbolLib() [1/2]

◆ EnumerateSymbolLib() [2/2]

◆ Format() [1/2]

◆ Format() [2/2]

◆ FormatLibSymbol()

◆ GetAvailableSymbolFields()

◆ GetDefaultSymbolFields()

◆ GetError()

◆ GetLibraryDesc()

◆ GetLibraryFileDesc()

◆ GetLibraryOptions()

◆ GetModifyHash()

◆ GetName()

◆ GetSchematicFileDesc()

◆ GetSubLibraryNames()

◆ init()

◆ isBuffering()

◆ IsLibraryWritable()

◆ LoadContent()

◆ loadFile()

◆ loadHierarchy()

◆ LoadSchematicFile()

◆ LoadSymbol()

◆ ParseLibSymbols()

◆ saveBitmap()

◆ saveBusAlias()

◆ saveBusEntry()

◆ saveField()

◆ saveInstances()

◆ saveJunction()

◆ SaveLibrary()

◆ saveLine()

◆ saveNoConnect()

◆ saveRuleArea()

◆ SaveSchematicFile()

◆ saveShape()

◆ saveSheet()

◆ SaveSymbol()

◆ saveSymbol()

◆ saveTable()

◆ saveText()

◆ saveTextBox()

◆ SetLibTable()

◆ SetProgressReporter()

◆ SetReporter()

◆ SupportsSubLibraries()

Member Data Documentation

◆ m_appending

◆ m_cache

◆ m_currentPath

◆ m_currentSheetPath

◆ m_error

◆ m_name

◆ m_nextFreeFieldId

◆ m_out

◆ m_path

◆ m_progressReporter

◆ m_reporter

◆ m_rootSheet

◆ m_schematic

◆ m_version

◆ PropBuffering