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 const wxString	GetFileExtension () const =0
	Returns the file extension for the PLUGIN. More...

virtual BOARD *	Load (const wxString &aFileName, BOARD aAppendToMe, const PROPERTIES 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	Save (const wxString &aFileName, BOARD aBoard, const PROPERTIES aProperties=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 PROPERTIES *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 PROPERTIES *aProperties=nullptr)
	If possible, prefetches the specified library (e.g. More...

virtual FOOTPRINT *	FootprintLoad (const wxString &aLibraryPath, const wxString &aFootprintName, bool aKeepUUID=false, const PROPERTIES *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 PROPERTIES *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 PROPERTIES *aProperties=nullptr)
	Check for the existence of a footprint. More...

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

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

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

virtual bool	FootprintLibDelete (const wxString &aLibraryPath, const PROPERTIES *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 (PROPERTIES *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 269 of file io_mgr.h.

Constructor & Destructor Documentation

◆ ~PLUGIN()

virtual PLUGIN::~PLUGIN ( )

inlinevirtual

Definition at line 545 of file io_mgr.h.

  {
  //printf( "~%s", __func__ );
  };

Member Function Documentation

◆ FootprintDelete()

void PLUGIN::FootprintDelete	(	const wxString &	aLibraryPath,
		const wxString &	aFootprintName,
		const PROPERTIES *	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 PCB_PLUGIN, and GPCB_PLUGIN.

Definition at line 116 of file plugin.cpp.

 {
  // not pure virtual so that plugins only have to implement subset of the PLUGIN interface.
  not_implemented( this, __FUNCTION__ );
 }

References not_implemented().

◆ FootprintEnumerate()

void PLUGIN::FootprintEnumerate	(	wxArrayString &	aFootprintNames,
		const wxString &	aLibraryPath,
		bool	aBestEfforts,
		const PROPERTIES *	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 PCB_PLUGIN, EAGLE_PLUGIN, LEGACY_PLUGIN, and GPCB_PLUGIN.

Definition at line 67 of file plugin.cpp.

 {
  // not pure virtual so that plugins only have to implement subset of the PLUGIN interface.
  not_implemented( this, __FUNCTION__ );
 }

References not_implemented().

◆ FootprintExists()

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

virtual

Check for the existence of a footprint.

Reimplemented in PCB_PLUGIN.

Definition at line 89 of file plugin.cpp.

 {
  // default implementation
  return FootprintLoad( aLibraryPath, aFootprintName, true, aProperties ) != nullptr;
 }

References FootprintLoad().

◆ FootprintLibCreate()

void PLUGIN::FootprintLibCreate	(	const wxString &	aLibraryPath,
		const PROPERTIES *	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 124 of file plugin.cpp.

 {
  // not pure virtual so that plugins only have to implement subset of the PLUGIN interface.
  not_implemented( this, __FUNCTION__ );
 }

References not_implemented().

◆ FootprintLibDelete()

bool PLUGIN::FootprintLibDelete	(	const wxString &	aLibraryPath,
		const PROPERTIES *	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 PCB_PLUGIN, LEGACY_PLUGIN, and GPCB_PLUGIN.

Definition at line 131 of file plugin.cpp.

 {
  // not pure virtual so that plugins only have to implement subset of the PLUGIN interface.
  not_implemented( this, __FUNCTION__ );
  return false;
 }

References not_implemented().

◆ FootprintLibOptions()

void PLUGIN::FootprintLibOptions ( PROPERTIES * 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_FP_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 147 of file plugin.cpp.

 {
  // disable all these in another couple of months, after everyone has seen them:
 #if 1
  (*aListToAppendTo)["debug_level"] = UTF8( _( "Enable <b>debug</b> logging for Footprint*() "
  "functions in this PLUGIN." ) );
 
  (*aListToAppendTo)["read_filter_regex"] = UTF8( _( "Regular expression <b>footprint name</b> "
  "filter." ) );
 
  (*aListToAppendTo)["enable_transaction_logging"] = UTF8( _( "Enable transaction logging. The "
  "mere presence of this option "
  "turns on the logging, no need to "
  "set a Value." ) );
 
  (*aListToAppendTo)["username"] = UTF8( _( "User name for <b>login</b> to some special library "
  "server." ) );
 
  (*aListToAppendTo)["password"] = UTF8( _( "Password for <b>login</b> to some special library "
  "server." ) );
 #endif
 
 #if 1
  // Suitable for a C++ to python PLUGIN::Footprint*() adapter, move it to the adapter
  // if and when implemented.
  (*aListToAppendTo)["python_footprint_plugin"] = UTF8( _( "Enter the python module which "
  "implements the PLUGIN::Footprint*() "
  "functions." ) );
 #endif
 }

References _.

Referenced by EAGLE_PLUGIN::FootprintLibOptions().

◆ FootprintLoad()

FOOTPRINT * PLUGIN::FootprintLoad	(	const wxString &	aLibraryPath,
		const wxString &	aFootprintName,
		bool	aKeepUUID = `false`,
		const PROPERTIES *	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 PCB_PLUGIN, EAGLE_PLUGIN, LEGACY_PLUGIN, and GPCB_PLUGIN.

Definition at line 97 of file plugin.cpp.

 {
  // not pure virtual so that plugins only have to implement subset of the PLUGIN interface.
  not_implemented( this, __FUNCTION__ );
  return nullptr;
 }

References not_implemented().

Referenced by FootprintExists(), and GetEnumeratedFootprint().

◆ FootprintSave()

void PLUGIN::FootprintSave	(	const wxString &	aLibraryPath,
		const FOOTPRINT *	aFootprint,
		const PROPERTIES *	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 108 of file plugin.cpp.

 {
  // not pure virtual so that plugins only have to implement subset of the PLUGIN interface.
  not_implemented( this, __FUNCTION__ );
 }

References not_implemented().

◆ GetEnumeratedFootprint()

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

virtual

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

Reimplemented in PCB_PLUGIN, and GPCB_PLUGIN.

Definition at line 80 of file plugin.cpp.

 {
  // default implementation
  return FootprintLoad( aLibraryPath, aFootprintName, false, aProperties );
 }

References FootprintLoad().

◆ GetFileExtension()

virtual const wxString PLUGIN::GetFileExtension ( ) const

pure virtual

Returns the file extension for the PLUGIN.

Implemented in PCB_PLUGIN, EAGLE_PLUGIN, LEGACY_PLUGIN, GPCB_PLUGIN, PCAD_PLUGIN, ALTIUM_DESIGNER_PLUGIN, ALTIUM_CIRCUIT_MAKER_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, FABMASTER_PLUGIN, and ALTIUM_CIRCUIT_STUDIO_PLUGIN.

Referenced by IO_MGR::GetFileExtension().

◆ 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 EAGLE_PLUGIN, and CADSTAR_PCB_ARCHIVE_PLUGIN.

Definition at line 54 of file plugin.cpp.

 {
  not_implemented( this, __FUNCTION__ );
  return std::vector<FOOTPRINT*>();
 }

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 PCB_PLUGIN, EAGLE_PLUGIN, LEGACY_PLUGIN, GPCB_PLUGIN, PCAD_PLUGIN, ALTIUM_DESIGNER_PLUGIN, ALTIUM_CIRCUIT_MAKER_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, FABMASTER_PLUGIN, and ALTIUM_CIRCUIT_STUDIO_PLUGIN.

◆ 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 PCB_PLUGIN, EAGLE_PLUGIN, LEGACY_PLUGIN, and GPCB_PLUGIN.

Definition at line 139 of file plugin.cpp.

 {
  // not pure virtual so that plugins only have to implement subset of the PLUGIN interface.
  not_implemented( this, __FUNCTION__ );
  return false;
 }

References not_implemented().

◆ Load()

BOARD * PLUGIN::Load	(	const wxString &	aFileName,
		BOARD *	aAppendToMe,
		const PROPERTIES *	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 PCB_PLUGIN, EAGLE_PLUGIN, LEGACY_PLUGIN, CLIPBOARD_IO, ALTIUM_DESIGNER_PLUGIN, PCAD_PLUGIN, ALTIUM_CIRCUIT_MAKER_PLUGIN, ALTIUM_CIRCUIT_STUDIO_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, and FABMASTER_PLUGIN.

Definition at line 46 of file plugin.cpp.

 {
  not_implemented( this, __FUNCTION__ );
  return nullptr;
 }

References not_implemented().

Referenced by PCB_CONTROL::AppendBoard(), IO_MGR::Load(), 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 PCB_PLUGIN, EAGLE_PLUGIN, LEGACY_PLUGIN, GPCB_PLUGIN, ALTIUM_DESIGNER_PLUGIN, PCAD_PLUGIN, ALTIUM_CIRCUIT_MAKER_PLUGIN, ALTIUM_CIRCUIT_STUDIO_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, and FABMASTER_PLUGIN.

Referenced by not_implemented().

◆ PrefetchLib()

void PLUGIN::PrefetchLib	(	const wxString &	aLibraryPath,
		const PROPERTIES *	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 75 of file plugin.cpp.

76 {

77 }

◆ Save()

void PLUGIN::Save	(	const wxString &	aFileName,
		BOARD *	aBoard,
		const PROPERTIES *	aProperties = `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.

Exceptions

IO_ERROR if there is a problem saving or exporting.

Reimplemented in PCB_PLUGIN, and CLIPBOARD_IO.

Definition at line 60 of file plugin.cpp.

 {
  // not pure virtual so that plugins only have to implement subset of the PLUGIN interface.
  not_implemented( this, __FUNCTION__ );
 }

References not_implemented().

Referenced by IO_MGR::Save().

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

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~PLUGIN()

Member Function Documentation

◆ FootprintDelete()

◆ FootprintEnumerate()

◆ FootprintExists()

◆ FootprintLibCreate()

◆ FootprintLibDelete()

◆ FootprintLibOptions()

◆ FootprintLoad()

◆ FootprintSave()

◆ GetEnumeratedFootprint()

◆ GetFileExtension()

◆ GetImportedCachedLibraryFootprints()

◆ GetLibraryTimestamp()

◆ IsFootprintLibWritable()

◆ Load()

◆ PluginName()

◆ PrefetchLib()

◆ Save()