A base class that BOARD loading and saving plugins should derive from. More...

#include <io_mgr.h>

Inheritance diagram for PLUGIN:

Classes
class	RELEASER
	Releases a PLUGIN in the context of a potential thrown exception through its destructor. More...

Public Member Functions
virtual const wxString	PluginName () const =0
	Return a brief hard coded name for this PLUGIN. More...

virtual PLUGIN_FILE_DESC	GetBoardFileDesc () const
	Returns board file description for the PLUGIN. More...

virtual PLUGIN_FILE_DESC	GetFootprintFileDesc () const
	Returns footprint file description for the PLUGIN. More...

virtual PLUGIN_FILE_DESC	GetFootprintLibDesc () const
	Returns footprint library description for the PLUGIN. More...

virtual bool	CanReadBoard (const wxString &aFileName) const
	Checks if this PLUGIN can read the specified board file. More...

virtual bool	CanReadFootprint (const wxString &aFileName) const
	Checks if this PLUGIN can read a footprint from specified file or directory. More...

virtual bool	CanReadFootprintLib (const wxString &aFileName) const
	Checks if this PLUGIN can read footprint library from specified file or directory. More...

virtual void	SetQueryUserCallback (std::function< bool(wxString aTitle, int aIcon, wxString aMessage, wxString aAction)> aCallback)
	Registers a KIDIALOG callback for collecting info from the user. More...

virtual BOARD *	LoadBoard (const wxString &aFileName, BOARD aAppendToMe, const STRING_UTF8_MAP aProperties=nullptr, PROJECT aProject=nullptr, PROGRESS_REPORTER aProgressReporter=nullptr)
	Load information from some input file format that this PLUGIN implementation knows about into either a new BOARD or an existing one. More...

virtual std::vector< FOOTPRINT * >	GetImportedCachedLibraryFootprints ()
	Return a container with the cached library footprints generated in the last call to Load. More...

virtual void	SaveBoard (const wxString &aFileName, BOARD aBoard, const STRING_UTF8_MAP aProperties=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr)
	Write aBoard to a storage file in a format that this PLUGIN implementation knows about or it can be used to write a portion of aBoard to a special kind of export file. More...

virtual void	FootprintEnumerate (wxArrayString &aFootprintNames, const wxString &aLibraryPath, bool aBestEfforts, const STRING_UTF8_MAP *aProperties=nullptr)
	Return a list of footprint names contained within the library at aLibraryPath. More...

virtual long long	GetLibraryTimestamp (const wxString &aLibraryPath) const =0
	Generate a timestamp representing all the files in the library (including the library directory). More...

virtual void	PrefetchLib (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr)
	If possible, prefetches the specified library (e.g. More...

virtual FOOTPRINT *	ImportFootprint (const wxString &aFootprintPath, wxString &aFootprintNameOut, const STRING_UTF8_MAP *aProperties=nullptr)
	Load a single footprint from aFootprintPath and put its name in aFootprintNameOut. More...

virtual FOOTPRINT *	FootprintLoad (const wxString &aLibraryPath, const wxString &aFootprintName, bool aKeepUUID=false, const STRING_UTF8_MAP *aProperties=nullptr)
	Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PLUGIN knows about. More...

virtual const FOOTPRINT *	GetEnumeratedFootprint (const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties=nullptr)
	A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management. More...

virtual bool	FootprintExists (const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties=nullptr)
	Check for the existence of a footprint. More...

virtual void	FootprintSave (const wxString &aLibraryPath, const FOOTPRINT aFootprint, const STRING_UTF8_MAP aProperties=nullptr)
	Write aFootprint to an existing library located at aLibraryPath. More...

virtual void	FootprintDelete (const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties=nullptr)
	Delete aFootprintName from the library at aLibraryPath. More...

virtual void	FootprintLibCreate (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr)
	Create a new empty footprint library at aLibraryPath empty. More...

virtual bool	FootprintLibDelete (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr)
	Delete an existing footprint 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. More...

virtual bool	IsFootprintLibWritable (const wxString &aLibraryPath)
	Return true if the library at aLibraryPath is writable. More...

virtual void	FootprintLibOptions (STRING_UTF8_MAP *aListToAppendTo) const
	Append supported PLUGIN options to aListToAppenTo along with internationalized descriptions. More...

virtual	~PLUGIN ()

Detailed Description

A base class that BOARD loading and saving plugins should derive from.

Implementations can provide either Load() or Save() functions, or both. PLUGINs throw exceptions, so it is best that you wrap your calls to these functions in a try catch block. Plugins throw exceptions because it is illegal for them to have any user interface calls in them whatsoever, i.e. no windowing or screen printing at all.

The compiler writes the "zero argument" constructor for a PLUGIN automatically if you do not provide one. If you decide you need to provide a zero argument constructor of your own design, that is allowed. It must be public, and it is what the IO_MGR uses. Parameters may be passed into a PLUGIN via the #PROPERTIES variable for any of the public API functions which take one.

   try
   {
        IO_MGR::Load(...);
   or
        IO_MGR::Save(...);
   }
   catch( const IO_ERROR& ioe )
   {
        // grab text from ioe, show in error window.
   }

Definition at line 271 of file io_mgr.h.

Constructor & Destructor Documentation

◆ ~PLUGIN()

virtual PLUGIN::~PLUGIN ( )

inlinevirtual

Definition at line 605 of file io_mgr.h.

Member Function Documentation

◆ CanReadBoard()

bool PLUGIN::CanReadBoard ( const wxString & aFileName ) const

virtual

Checks if this PLUGIN can read the specified board file.

If not overriden, extension check is used.

Reimplemented in ALTIUM_CIRCUIT_MAKER_PLUGIN, ALTIUM_CIRCUIT_STUDIO_PLUGIN, ALTIUM_DESIGNER_PLUGIN, SOLIDWORKS_PCB_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, EAGLE_PLUGIN, EASYEDA_PLUGIN, EASYEDAPRO_PLUGIN, IPC2581_PLUGIN, PCB_PLUGIN, LEGACY_PLUGIN, and PCAD_PLUGIN.

Definition at line 61 of file plugin.cpp.

References GetBoardFileDesc(), and PLUGIN_FILE_DESC::m_FileExtensions.

Referenced by ALTIUM_CIRCUIT_MAKER_PLUGIN::CanReadBoard(), ALTIUM_CIRCUIT_STUDIO_PLUGIN::CanReadBoard(), ALTIUM_DESIGNER_PLUGIN::CanReadBoard(), SOLIDWORKS_PCB_PLUGIN::CanReadBoard(), CADSTAR_PCB_ARCHIVE_PLUGIN::CanReadBoard(), EAGLE_PLUGIN::CanReadBoard(), EASYEDA_PLUGIN::CanReadBoard(), PCB_PLUGIN::CanReadBoard(), LEGACY_PLUGIN::CanReadBoard(), PCAD_PLUGIN::CanReadBoard(), and IO_MGR::FindPluginTypeFromBoardPath().

◆ CanReadFootprint()

bool PLUGIN::CanReadFootprint ( const wxString & aFileName ) const

virtual

Checks if this PLUGIN can read a footprint from specified file or directory.

If not overriden, extension check is used.

Reimplemented in CADSTAR_PCB_ARCHIVE_PLUGIN, EAGLE_PLUGIN, EASYEDA_PLUGIN, IPC2581_PLUGIN, and LEGACY_PLUGIN.

Definition at line 77 of file plugin.cpp.

References GetFootprintFileDesc(), and PLUGIN_FILE_DESC::m_FileExtensions.

Referenced by CADSTAR_PCB_ARCHIVE_PLUGIN::CanReadFootprint(), LEGACY_PLUGIN::CanReadFootprint(), and FOOTPRINT_EDIT_FRAME::ImportFootprint().

◆ CanReadFootprintLib()

bool PLUGIN::CanReadFootprintLib ( const wxString & aFileName ) const

virtual

Checks if this PLUGIN can read footprint library from specified file or directory.

If not overriden, extension check is used.

Reimplemented in ALTIUM_DESIGNER_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, EAGLE_PLUGIN, EASYEDA_PLUGIN, and IPC2581_PLUGIN.

Definition at line 93 of file plugin.cpp.

References GetFootprintLibDesc(), PLUGIN_FILE_DESC::m_ExtensionsInDir, PLUGIN_FILE_DESC::m_FileExtensions, and PLUGIN_FILE_DESC::m_IsFile.

Referenced by ALTIUM_DESIGNER_PLUGIN::CanReadFootprintLib(), CADSTAR_PCB_ARCHIVE_PLUGIN::CanReadFootprintLib(), EAGLE_PLUGIN::CanReadFootprintLib(), and IO_MGR::GuessPluginTypeFromLibPath().

◆ FootprintDelete()

void PLUGIN::FootprintDelete	(	const wxString &	aLibraryPath,
		const wxString &	aFootprintName,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

Delete aFootprintName from the library at aLibraryPath.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several footprints.
aFootprintName	is the name of a footprint 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 footprint or the library, or deleting it.

Reimplemented in GPCB_PLUGIN, and PCB_PLUGIN.

Definition at line 234 of file plugin.cpp.

References NOT_IMPLEMENTED.

Referenced by FP_LIB_TABLE::FootprintDelete().

◆ FootprintEnumerate()

void PLUGIN::FootprintEnumerate	(	wxArrayString &	aFootprintNames,
		const wxString &	aLibraryPath,
		bool	aBestEfforts,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

Return a list of footprint names contained within the library at aLibraryPath.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several footprints.
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.
aFootprintNames	is the array of available footprint names inside a library.
aBestEfforts	if true, don't throw on errors, just return an empty list.

Exceptions

IO_ERROR if the library cannot be found, or footprint cannot be loaded.

Reimplemented in ALTIUM_DESIGNER_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, EAGLE_PLUGIN, EASYEDA_PLUGIN, EASYEDAPRO_PLUGIN, GPCB_PLUGIN, PCB_PLUGIN, and LEGACY_PLUGIN.

Definition at line 166 of file plugin.cpp.

References NOT_IMPLEMENTED.

Referenced by PANEL_FP_LIB_TABLE::convertLibrary(), FP_LIB_TABLE::FootprintEnumerate(), ImportFootprint(), and FOOTPRINT_EDIT_FRAME::SaveLibraryAs().

◆ FootprintExists()

bool PLUGIN::FootprintExists	(	const wxString &	aLibraryPath,
		const wxString &	aFootprintName,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

Check for the existence of a footprint.

Reimplemented in CADSTAR_PCB_ARCHIVE_PLUGIN, and PCB_PLUGIN.

Definition at line 210 of file plugin.cpp.

References FootprintLoad().

Referenced by FP_LIB_TABLE::FootprintExists().

◆ FootprintLibCreate()

void PLUGIN::FootprintLibCreate	(	const wxString &	aLibraryPath,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

Create a new empty footprint 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 footprints.
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 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 library, or creating it.

Reimplemented in PCB_PLUGIN.

Definition at line 242 of file plugin.cpp.

References NOT_IMPLEMENTED.

Referenced by PCB_BASE_EDIT_FRAME::createNewLibrary(), and FP_LIB_TABLE::FootprintLibCreate().

◆ FootprintLibDelete()

bool PLUGIN::FootprintLibDelete	(	const wxString &	aLibraryPath,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

Delete an existing footprint 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 footprints.
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 in GPCB_PLUGIN, PCB_PLUGIN, and LEGACY_PLUGIN.

Definition at line 249 of file plugin.cpp.

References NOT_IMPLEMENTED.

Referenced by PCB_BASE_EDIT_FRAME::createNewLibrary(), and FP_LIB_TABLE::FootprintLibDelete().

◆ FootprintLibOptions()

void PLUGIN::FootprintLibOptions ( STRING_UTF8_MAP * aListToAppendTo ) const

virtual

Append supported PLUGIN options to aListToAppenTo along with internationalized descriptions.

Options are typically appended so that a derived PLUGIN can call its base class function by the same name first, thus inheriting options declared there. Some base class options could pertain to all Footprint*() functions in all derived PLUGINs.

Note: 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 PLUGIN, which has been avoided to date.

Reimplemented in EAGLE_PLUGIN.

Definition at line 263 of file plugin.cpp.

References _.

Referenced by EAGLE_PLUGIN::FootprintLibOptions(), and FP_GRID_TRICKS::optionsEditor().

◆ FootprintLoad()

FOOTPRINT * PLUGIN::FootprintLoad	(	const wxString &	aLibraryPath,
		const wxString &	aFootprintName,
		bool	aKeepUUID = `false`,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PLUGIN knows about.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several footprints.
aFootprintName	is the name of the footprint 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.
aKeepUUID	= true to keep initial items UUID, false to set new UUID normally true if loaded in the footprint editor, false if loaded in the board editor. Make sense only in kicad_plugin

Returns: the FOOTPRINT object if found, caller owns it, else NULL if not found.

Exceptions

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

Reimplemented in ALTIUM_DESIGNER_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, EAGLE_PLUGIN, EASYEDA_PLUGIN, EASYEDAPRO_PLUGIN, GPCB_PLUGIN, PCB_PLUGIN, and LEGACY_PLUGIN.

Definition at line 218 of file plugin.cpp.

References NOT_IMPLEMENTED.

Referenced by FootprintExists(), FP_LIB_TABLE::FootprintLoad(), FP_LIB_TABLE::FootprintSave(), GetEnumeratedFootprint(), and ImportFootprint().

◆ FootprintSave()

void PLUGIN::FootprintSave	(	const wxString &	aLibraryPath,
		const FOOTPRINT *	aFootprint,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

Write aFootprint to an existing library located at aLibraryPath.

If a footprint by the same name already exists, it is replaced.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several footprints.
aFootprint	is what to store in the library. The caller continues to own the footprint after this call.
aProperties	is an associative array that can be used to tell the saver how to save the footprint, 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 in PCB_PLUGIN.

Definition at line 226 of file plugin.cpp.

References NOT_IMPLEMENTED.

Referenced by PANEL_FP_LIB_TABLE::convertLibrary(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), FP_LIB_TABLE::FootprintSave(), PCB_EDIT_FRAME::OpenProjectFiles(), and FOOTPRINT_EDIT_FRAME::SaveLibraryAs().

◆ GetBoardFileDesc()

PLUGIN_FILE_DESC PLUGIN::GetBoardFileDesc ( ) const

virtual

Returns board file description for the PLUGIN.

Reimplemented in ALTIUM_CIRCUIT_MAKER_PLUGIN, ALTIUM_CIRCUIT_STUDIO_PLUGIN, ALTIUM_DESIGNER_PLUGIN, SOLIDWORKS_PCB_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, EAGLE_PLUGIN, EASYEDA_PLUGIN, EASYEDAPRO_PLUGIN, FABMASTER_PLUGIN, IPC2581_PLUGIN, PCB_PLUGIN, LEGACY_PLUGIN, and PCAD_PLUGIN.

Definition at line 43 of file plugin.cpp.

Referenced by AskLoadBoardFileName(), and CanReadBoard().

◆ GetEnumeratedFootprint()

const FOOTPRINT * PLUGIN::GetEnumeratedFootprint	(	const wxString &	aLibraryPath,
		const wxString &	aFootprintName,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management.

Reimplemented in GPCB_PLUGIN, and PCB_PLUGIN.

Definition at line 201 of file plugin.cpp.

References FootprintLoad().

Referenced by PANEL_FP_LIB_TABLE::convertLibrary(), FP_LIB_TABLE::GetEnumeratedFootprint(), and FOOTPRINT_EDIT_FRAME::SaveLibraryAs().

◆ GetFootprintFileDesc()

PLUGIN_FILE_DESC PLUGIN::GetFootprintFileDesc ( ) const

virtual

Returns footprint file description for the PLUGIN.

Reimplemented in ALTIUM_DESIGNER_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, EAGLE_PLUGIN, EASYEDA_PLUGIN, EASYEDAPRO_PLUGIN, GPCB_PLUGIN, PCB_PLUGIN, and LEGACY_PLUGIN.

Definition at line 49 of file plugin.cpp.

Referenced by CanReadFootprint(), and FOOTPRINT_EDIT_FRAME::ImportFootprint().

◆ GetFootprintLibDesc()

PLUGIN_FILE_DESC PLUGIN::GetFootprintLibDesc ( ) const

virtual

Returns footprint library description for the PLUGIN.

Reimplemented in ALTIUM_DESIGNER_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, EAGLE_PLUGIN, EASYEDA_PLUGIN, EASYEDAPRO_PLUGIN, GPCB_PLUGIN, PCB_PLUGIN, and LEGACY_PLUGIN.

Definition at line 55 of file plugin.cpp.

Referenced by CanReadFootprintLib(), and PANEL_FP_LIB_TABLE::populatePluginList().

◆ GetImportedCachedLibraryFootprints()

std::vector< FOOTPRINT * > PLUGIN::GetImportedCachedLibraryFootprints ( )

virtual

Return a container with the cached library footprints generated in the last call to Load.

This function is intended to be used ONLY by the non-KiCad board importers for the purpose of obtaining the footprint library of the design and creating a project-specific library.

Returns: Footprints (caller owns the objects)

Reimplemented in CADSTAR_PCB_ARCHIVE_PLUGIN, EAGLE_PLUGIN, EASYEDA_PLUGIN, EASYEDAPRO_PLUGIN, and IPC2581_PLUGIN.

Definition at line 152 of file plugin.cpp.

References NOT_IMPLEMENTED.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ GetLibraryTimestamp()

virtual long long PLUGIN::GetLibraryTimestamp ( const wxString & aLibraryPath ) const

pure virtual

Generate a timestamp representing all the files in the library (including the library directory).

Timestamps should not be considered ordered, they either match or they don't.

Implemented in ALTIUM_CIRCUIT_MAKER_PLUGIN, ALTIUM_CIRCUIT_STUDIO_PLUGIN, ALTIUM_DESIGNER_PLUGIN, SOLIDWORKS_PCB_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, EAGLE_PLUGIN, EASYEDA_PLUGIN, EASYEDAPRO_PLUGIN, FABMASTER_PLUGIN, GPCB_PLUGIN, IPC2581_PLUGIN, PCB_PLUGIN, LEGACY_PLUGIN, and PCAD_PLUGIN.

Referenced by FP_LIB_TABLE::GenerateTimestamp().

◆ ImportFootprint()

FOOTPRINT * PLUGIN::ImportFootprint	(	const wxString &	aFootprintPath,
		wxString &	aFootprintNameOut,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

Load a single footprint from aFootprintPath and put its name in aFootprintNameOut.

If this is a footprint library, the first footprint should be loaded. The default implementation uses FootprintEnumerate and FootprintLoad to load first footprint.

Parameters

aLibraryPath	is a path of the footprint file.
aFootprintNameOut	is the name output of the loaded footprint.
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 FOOTPRINT object if found, caller owns it, else NULL if not found.

Exceptions

IO_ERROR if the footprint cannot be found or read.

Reimplemented in GPCB_PLUGIN, and PCB_PLUGIN.

Definition at line 179 of file plugin.cpp.

References _, FootprintEnumerate(), and FootprintLoad().

Referenced by FOOTPRINT_EDIT_FRAME::ImportFootprint().

◆ IsFootprintLibWritable()

bool PLUGIN::IsFootprintLibWritable ( const wxString & aLibraryPath )

virtual

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 in ALTIUM_DESIGNER_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, EAGLE_PLUGIN, EASYEDA_PLUGIN, EASYEDAPRO_PLUGIN, GPCB_PLUGIN, PCB_PLUGIN, and LEGACY_PLUGIN.

Definition at line 256 of file plugin.cpp.

References NOT_IMPLEMENTED.

Referenced by PCB_BASE_EDIT_FRAME::createNewLibrary(), and FP_LIB_TABLE::IsFootprintLibWritable().

◆ LoadBoard()

BOARD * PLUGIN::LoadBoard	(	const wxString &	aFileName,
		BOARD *	aAppendToMe,
		const STRING_UTF8_MAP *	aProperties = `nullptr`,
		PROJECT *	aProject = `nullptr`,
		PROGRESS_REPORTER *	aProgressReporter = `nullptr`
	)

virtual

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

This may be used to load an entire new BOARD, 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.
aAppendToMe	is an existing BOARD 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.
aProject	is the optional PROJECT object primarily used by third party importers.
aProgressReporter	an optional progress reporter
aLineCount	a line count (necessary if a progress reporter is supplied)

Returns: the successfully loaded board, or the same one as aAppendToMe if aAppendToMe was not NULL, and 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 in ALTIUM_CIRCUIT_STUDIO_PLUGIN, ALTIUM_CIRCUIT_MAKER_PLUGIN, ALTIUM_DESIGNER_PLUGIN, SOLIDWORKS_PCB_PLUGIN, CLIPBOARD_IO, CADSTAR_PCB_ARCHIVE_PLUGIN, EAGLE_PLUGIN, EASYEDA_PLUGIN, EASYEDAPRO_PLUGIN, FABMASTER_PLUGIN, PCB_PLUGIN, LEGACY_PLUGIN, and PCAD_PLUGIN.

Definition at line 144 of file plugin.cpp.

References NOT_IMPLEMENTED.

Referenced by PCB_CONTROL::AppendBoard(), IO_MGR::Load(), PCB_TEST_FRAME_BASE::LoadAndDisplayBoard(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ PluginName()

virtual const wxString PLUGIN::PluginName ( ) const

pure virtual

Return a brief hard coded name for this PLUGIN.

Implemented in ALTIUM_CIRCUIT_MAKER_PLUGIN, ALTIUM_CIRCUIT_STUDIO_PLUGIN, ALTIUM_DESIGNER_PLUGIN, SOLIDWORKS_PCB_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, EAGLE_PLUGIN, EASYEDA_PLUGIN, EASYEDAPRO_PLUGIN, FABMASTER_PLUGIN, GPCB_PLUGIN, IPC2581_PLUGIN, PCB_PLUGIN, LEGACY_PLUGIN, and PCAD_PLUGIN.

◆ PrefetchLib()

void PLUGIN::PrefetchLib	(	const wxString &	aLibraryPath,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

virtual

If possible, prefetches the specified library (e.g.

performing downloads). Does not parse. Threadsafe.

This is a no-op for libraries that cannot be prefetched. Plugins that cannot prefetch need not override this; a default no-op is provided.

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several footprints.
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 there is an error prefetching the library.

Definition at line 174 of file plugin.cpp.

Referenced by FP_LIB_TABLE::PrefetchLib().

◆ SaveBoard()

void PLUGIN::SaveBoard	(	const wxString &	aFileName,
		BOARD *	aBoard,
		const STRING_UTF8_MAP *	aProperties = `nullptr`,
		PROGRESS_REPORTER *	aProgressReporter = `nullptr`
	)

virtual

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

Parameters

aFileName	is the name of a file to save to on disk.
aBoard	is the class BOARD in memory document tree from which to extract information when writing to aFileName. The caller continues to own the BOARD, and the plugin should refrain from modifying the BOARD if possible.
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.
aProgressReporter	an optional progress reporter

Exceptions

IO_ERROR if there is a problem saving or exporting.

Reimplemented in CLIPBOARD_IO, IPC2581_PLUGIN, and PCB_PLUGIN.

Definition at line 158 of file plugin.cpp.

References NOT_IMPLEMENTED.

Referenced by PCB_EDIT_FRAME::GenIPC2581File(), IO_MGR::Save(), PCB_EDIT_FRAME::SavePcbCopy(), and PCB_EDIT_FRAME::SavePcbFile().

◆ SetQueryUserCallback()

virtual void PLUGIN::SetQueryUserCallback ( std::function< bool(wxString aTitle, int aIcon, wxString aMessage, wxString aAction)> aCallback )

inlinevirtual

Registers a KIDIALOG callback for collecting info from the user.

Definition at line 315 of file io_mgr.h.

Referenced by PCB_CONTROL::AppendBoard(), and PCB_EDIT_FRAME::OpenProjectFiles().

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

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~PLUGIN()

Member Function Documentation

◆ CanReadBoard()

◆ CanReadFootprint()

◆ CanReadFootprintLib()

◆ FootprintDelete()

◆ FootprintEnumerate()

◆ FootprintExists()

◆ FootprintLibCreate()

◆ FootprintLibDelete()

◆ FootprintLibOptions()

◆ FootprintLoad()

◆ FootprintSave()

◆ GetBoardFileDesc()

◆ GetEnumeratedFootprint()

◆ GetFootprintFileDesc()

◆ GetFootprintLibDesc()

◆ GetImportedCachedLibraryFootprints()

◆ GetLibraryTimestamp()

◆ ImportFootprint()

◆ IsFootprintLibWritable()

◆ LoadBoard()

◆ PluginName()

◆ PrefetchLib()

◆ SaveBoard()

◆ SetQueryUserCallback()