![]() |
KiCad PCB EDA Suite
|
A base class that BOARD loading and saving plugins should derive from. More...
#include <io_mgr.h>
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) |
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, 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 () |
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. }
|
inlinevirtual |
|
virtual |
Delete aFootprintName from the library at aLibraryPath.
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. |
IO_ERROR | if there is a problem finding the footprint or the library, or deleting it. |
Reimplemented in PCB_IO, and GPCB_PLUGIN.
Definition at line 116 of file plugin.cpp.
References not_implemented().
|
virtual |
Return a list of footprint names contained within the library at aLibraryPath.
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. |
IO_ERROR | if the library cannot be found, or footprint cannot be loaded. |
Reimplemented in PCB_IO, EAGLE_PLUGIN, LEGACY_PLUGIN, and GPCB_PLUGIN.
Definition at line 67 of file plugin.cpp.
References not_implemented().
|
virtual |
Check for the existence of a footprint.
Reimplemented in PCB_IO.
Definition at line 91 of file plugin.cpp.
References FootprintLoad().
|
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.
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. |
IO_ERROR | if there is a problem finding the library, or creating it. |
Reimplemented in PCB_IO.
Definition at line 124 of file plugin.cpp.
References not_implemented().
|
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.
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. |
IO_ERROR | if there is a problem deleting an existing library. |
Reimplemented in PCB_IO, LEGACY_PLUGIN, and GPCB_PLUGIN.
Definition at line 131 of file plugin.cpp.
References not_implemented().
|
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.
aListToAppendTo | holds a tuple of
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.
References _.
Referenced by EAGLE_PLUGIN::FootprintLibOptions().
|
virtual |
Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PLUGIN knows about.
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. |
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_IO, EAGLE_PLUGIN, LEGACY_PLUGIN, and GPCB_PLUGIN.
Definition at line 99 of file plugin.cpp.
References not_implemented().
Referenced by FootprintExists(), and GetEnumeratedFootprint().
|
virtual |
Write aFootprint to an existing library located at aLibraryPath.
If a footprint by the same name already exists, it is replaced.
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. |
IO_ERROR | if there is a problem saving. |
Reimplemented in PCB_IO.
Definition at line 108 of file plugin.cpp.
References not_implemented().
|
virtual |
A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management.
Reimplemented in PCB_IO, and GPCB_PLUGIN.
Definition at line 82 of file plugin.cpp.
References FootprintLoad().
|
pure virtual |
Returns the file extension for the PLUGIN.
Implemented in PCB_IO, EAGLE_PLUGIN, LEGACY_PLUGIN, GPCB_PLUGIN, FABMASTER_PLUGIN, ALTIUM_DESIGNER_PLUGIN, PCAD_PLUGIN, ALTIUM_CIRCUIT_MAKER_PLUGIN, ALTIUM_CIRCUIT_STUDIO_PLUGIN, and CADSTAR_PCB_ARCHIVE_PLUGIN.
Referenced by IO_MGR::GetFileExtension().
|
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.
Reimplemented in EAGLE_PLUGIN, and CADSTAR_PCB_ARCHIVE_PLUGIN.
Definition at line 54 of file plugin.cpp.
References not_implemented().
Referenced by PCB_EDIT_FRAME::OpenProjectFiles().
|
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_IO, EAGLE_PLUGIN, LEGACY_PLUGIN, GPCB_PLUGIN, FABMASTER_PLUGIN, ALTIUM_DESIGNER_PLUGIN, PCAD_PLUGIN, ALTIUM_CIRCUIT_MAKER_PLUGIN, ALTIUM_CIRCUIT_STUDIO_PLUGIN, and CADSTAR_PCB_ARCHIVE_PLUGIN.
|
virtual |
Return true if the library at aLibraryPath is writable.
The system libraries are typically read only because of where they are installed..
aLibraryPath | is a locator for the "library", usually a directory, file, or URL containing several footprints. |
IO_ERROR | if no library at aLibraryPath exists. |
Reimplemented in PCB_IO, EAGLE_PLUGIN, LEGACY_PLUGIN, and GPCB_PLUGIN.
Definition at line 139 of file plugin.cpp.
References not_implemented().
|
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.
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. |
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_IO, EAGLE_PLUGIN, LEGACY_PLUGIN, CLIPBOARD_IO, FABMASTER_PLUGIN, ALTIUM_DESIGNER_PLUGIN, ALTIUM_CIRCUIT_MAKER_PLUGIN, ALTIUM_CIRCUIT_STUDIO_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, and PCAD_PLUGIN.
Definition at line 46 of file plugin.cpp.
References not_implemented().
Referenced by PCB_CONTROL::AppendBoard(), IO_MGR::Load(), and PCB_EDIT_FRAME::OpenProjectFiles().
|
pure virtual |
Return a brief hard coded name for this PLUGIN.
Implemented in PCB_IO, EAGLE_PLUGIN, LEGACY_PLUGIN, GPCB_PLUGIN, FABMASTER_PLUGIN, ALTIUM_DESIGNER_PLUGIN, ALTIUM_CIRCUIT_MAKER_PLUGIN, ALTIUM_CIRCUIT_STUDIO_PLUGIN, CADSTAR_PCB_ARCHIVE_PLUGIN, and PCAD_PLUGIN.
Referenced by not_implemented().
|
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.
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. |
IO_ERROR | if there is an error prefetching the library. |
Definition at line 75 of file plugin.cpp.
|
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.
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. |
IO_ERROR | if there is a problem saving or exporting. |
Reimplemented in PCB_IO, and CLIPBOARD_IO.
Definition at line 60 of file plugin.cpp.
References not_implemented().
Referenced by IO_MGR::Save().