KiCad PCB EDA Suite
|
#include <altium_circuit_studio_plugin.h>
Public Member Functions | |
const wxString | PluginName () const override |
Return a brief hard coded name for this PLUGIN. More... | |
PLUGIN_FILE_DESC | GetBoardFileDesc () const override |
Returns board file description for the PLUGIN. More... | |
bool | CanReadBoard (const wxString &aFileName) const override |
Checks if this PLUGIN can read the specified board file. More... | |
BOARD * | LoadBoard (const wxString &aFileName, BOARD *aAppendToMe, const STRING_UTF8_MAP *aProperties, PROJECT *aProject, PROGRESS_REPORTER *aProgressReporter=nullptr) override |
Load information from some input file format that this PLUGIN implementation knows about into either a new BOARD or an existing one. More... | |
long long | GetLibraryTimestamp (const wxString &aLibraryPath) const override |
Generate a timestamp representing all the files in the library (including the library directory). More... | |
ALTIUM_CIRCUIT_STUDIO_PLUGIN () | |
~ALTIUM_CIRCUIT_STUDIO_PLUGIN () | |
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 | 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 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 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... | |
Private Attributes | |
const STRING_UTF8_MAP * | m_props |
BOARD * | m_board |
Definition at line 31 of file altium_circuit_studio_plugin.h.
ALTIUM_CIRCUIT_STUDIO_PLUGIN::ALTIUM_CIRCUIT_STUDIO_PLUGIN | ( | ) |
Definition at line 42 of file altium_circuit_studio_plugin.cpp.
ALTIUM_CIRCUIT_STUDIO_PLUGIN::~ALTIUM_CIRCUIT_STUDIO_PLUGIN | ( | ) |
Definition at line 49 of file altium_circuit_studio_plugin.cpp.
|
overridevirtual |
Checks if this PLUGIN can read the specified board file.
If not overriden, extension check is used.
Reimplemented from PLUGIN.
Definition at line 66 of file altium_circuit_studio_plugin.cpp.
References PLUGIN::CanReadBoard(), and ALTIUM_DESIGNER_PLUGIN::checkFileHeader().
|
virtualinherited |
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 PLUGIN::GetFootprintFileDesc(), and PLUGIN_FILE_DESC::m_FileExtensions.
Referenced by CADSTAR_PCB_ARCHIVE_PLUGIN::CanReadFootprint(), LEGACY_PLUGIN::CanReadFootprint(), and FOOTPRINT_EDIT_FRAME::ImportFootprint().
|
virtualinherited |
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 PLUGIN::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().
|
virtualinherited |
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 GPCB_PLUGIN, and PCB_PLUGIN.
Definition at line 234 of file plugin.cpp.
References NOT_IMPLEMENTED.
Referenced by FP_LIB_TABLE::FootprintDelete().
|
virtualinherited |
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 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(), PLUGIN::ImportFootprint(), and FOOTPRINT_EDIT_FRAME::SaveLibraryAs().
|
virtualinherited |
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 PLUGIN::FootprintLoad().
Referenced by FP_LIB_TABLE::FootprintExists().
|
virtualinherited |
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_PLUGIN.
Definition at line 242 of file plugin.cpp.
References NOT_IMPLEMENTED.
Referenced by PCB_BASE_EDIT_FRAME::createNewLibrary(), and FP_LIB_TABLE::FootprintLibCreate().
|
virtualinherited |
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 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().
|
virtualinherited |
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 263 of file plugin.cpp.
References _.
Referenced by EAGLE_PLUGIN::FootprintLibOptions(), and FP_GRID_TRICKS::optionsEditor().
|
virtualinherited |
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. |
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 |
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 PLUGIN::FootprintExists(), FP_LIB_TABLE::FootprintLoad(), FP_LIB_TABLE::FootprintSave(), PLUGIN::GetEnumeratedFootprint(), and PLUGIN::ImportFootprint().
|
virtualinherited |
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_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().
|
overridevirtual |
Returns board file description for the PLUGIN.
Reimplemented from PLUGIN.
Definition at line 60 of file altium_circuit_studio_plugin.cpp.
References _HKI.
|
virtualinherited |
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 PLUGIN::FootprintLoad().
Referenced by PANEL_FP_LIB_TABLE::convertLibrary(), FP_LIB_TABLE::GetEnumeratedFootprint(), and FOOTPRINT_EDIT_FRAME::SaveLibraryAs().
|
virtualinherited |
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 PLUGIN::CanReadFootprint(), and FOOTPRINT_EDIT_FRAME::ImportFootprint().
|
virtualinherited |
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 PLUGIN::CanReadFootprintLib(), and PANEL_FP_LIB_TABLE::populatePluginList().
|
virtualinherited |
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 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().
|
inlineoverridevirtual |
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.
Implements PLUGIN.
Definition at line 44 of file altium_circuit_studio_plugin.h.
|
virtualinherited |
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.
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. |
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 _, PLUGIN::FootprintEnumerate(), and PLUGIN::FootprintLoad().
Referenced by FOOTPRINT_EDIT_FRAME::ImportFootprint().
|
virtualinherited |
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 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().
|
overridevirtual |
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. |
aProgressReporter | an optional progress reporter |
aLineCount | a line count (necessary if a progress reporter is supplied) |
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 PLUGIN.
Definition at line 75 of file altium_circuit_studio_plugin.cpp.
References m_board, m_props, ALTIUM_PCB::Parse(), BOARD::SetFileName(), and THROW_IO_ERROR.
|
overridevirtual |
Return a brief hard coded name for this PLUGIN.
Implements PLUGIN.
Definition at line 54 of file altium_circuit_studio_plugin.cpp.
|
virtualinherited |
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 174 of file plugin.cpp.
Referenced by FP_LIB_TABLE::PrefetchLib().
|
virtualinherited |
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. |
aProgressReporter | an optional progress reporter |
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().
|
inlinevirtualinherited |
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().
|
private |
Definition at line 55 of file altium_circuit_studio_plugin.h.
Referenced by ALTIUM_CIRCUIT_STUDIO_PLUGIN(), and LoadBoard().
|
private |
Definition at line 54 of file altium_circuit_studio_plugin.h.
Referenced by ALTIUM_CIRCUIT_STUDIO_PLUGIN(), and LoadBoard().