A PLUGIN derivation for saving and loading Geda PCB files. More...

#include <gpcb_plugin.h>

Inheritance diagram for GPCB_PLUGIN:

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

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

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

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

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

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

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

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

bool	FootprintLibDelete (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
	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...

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

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

	GPCB_PLUGIN ()

	GPCB_PLUGIN (int aControlFlags)

	~GPCB_PLUGIN ()

virtual PLUGIN_FILE_DESC	GetBoardFileDesc () const
	Returns board file 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	PrefetchLib (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr)
	If possible, prefetches the specified library (e.g. 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	FootprintLibCreate (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr)
	Create a new empty footprint library at aLibraryPath empty. More...

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

Protected Attributes
wxString	m_error
	for throwing exceptions More...

const STRING_UTF8_MAP *	m_props
	passed via Save() or Load(), no ownership, may be NULL. More...

GPCB_FPL_CACHE *	m_cache
	Footprint library cache. More...

int	m_ctl

LINE_READER *	m_reader
	no ownership here. More...

wxString	m_filename
	for saves only, name is in m_reader for loads More...

Private Member Functions
void	validateCache (const wxString &aLibraryPath, bool checkModified=true)

const FOOTPRINT *	getFootprint (const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties, bool checkModified)

void	init (const STRING_UTF8_MAP *aProperties)

Friends
class	GPCB_FPL_CACHE

Detailed Description

A PLUGIN derivation for saving and loading Geda PCB files.

Note: This class is not thread safe, but it is re-entrant multiple times in sequence.; Currently only reading GPCB footprint files is implemented.

Definition at line 46 of file gpcb_plugin.h.

Constructor & Destructor Documentation

◆ GPCB_PLUGIN() [1/2]

GPCB_PLUGIN::GPCB_PLUGIN ( )

Definition at line 795 of file gpcb_plugin.cpp.

References init(), and m_reader.

◆ GPCB_PLUGIN() [2/2]

GPCB_PLUGIN::GPCB_PLUGIN ( int aControlFlags )

Definition at line 804 of file gpcb_plugin.cpp.

References init(), and m_reader.

◆ ~GPCB_PLUGIN()

GPCB_PLUGIN::~GPCB_PLUGIN ( )

Definition at line 813 of file gpcb_plugin.cpp.

References m_cache.

Member Function Documentation

◆ CanReadBoard()

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

virtualinherited

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 PLUGIN::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

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

◆ CanReadFootprintLib()

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

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

◆ FootprintDelete()

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

overridevirtual

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

Definition at line 949 of file gpcb_plugin.cpp.

References _, init(), GPCB_FPL_CACHE::IsWritable(), m_cache, GPCB_FPL_CACHE::Remove(), THROW_IO_ERROR, and validateCache().

◆ FootprintEnumerate()

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

overridevirtual

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

Definition at line 861 of file gpcb_plugin.cpp.

References _, From_UTF8(), GPCB_FPL_CACHE::GetFootprints(), init(), m_cache, THROW_IO_ERROR, validateCache(), and IO_ERROR::What().

◆ FootprintExists()

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

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

◆ FootprintLibCreate()

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

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.

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 GPCB_PLUGIN::FootprintLibDelete	(	const wxString &	aLibraryPath,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

overridevirtual

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

Definition at line 968 of file gpcb_plugin.cpp.

References _, GPCB_FPL_CACHE::GetPath(), KiCadFootprintFileExtension, m_cache, THROW_IO_ERROR, and traceGedaPcbPlugin.

◆ FootprintLibOptions()

void PLUGIN::FootprintLibOptions ( STRING_UTF8_MAP * aListToAppendTo ) const

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.

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 * GPCB_PLUGIN::FootprintLoad	(	const wxString &	aLibraryPath,
		const wxString &	aFootprintName,
		bool	aKeepUUID = `false`,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

overridevirtual

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

Definition at line 931 of file gpcb_plugin.cpp.

References copy, FOOTPRINT::Duplicate(), and getFootprint().

Referenced by ImportFootprint().

◆ FootprintSave()

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

virtualinherited

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

virtualinherited

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 PLUGIN::CanReadBoard().

◆ GetEnumeratedFootprint()

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

overridevirtual

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

Reimplemented from PLUGIN.

Definition at line 923 of file gpcb_plugin.cpp.

References getFootprint().

◆ getFootprint()

const FOOTPRINT * GPCB_PLUGIN::getFootprint	(	const wxString &	aLibraryPath,
		const wxString &	aFootprintName,
		const STRING_UTF8_MAP *	aProperties,
		bool	checkModified
	)

private

Definition at line 901 of file gpcb_plugin.cpp.

References GPCB_FPL_CACHE::GetFootprints(), init(), m_cache, TO_UTF8, and validateCache().

Referenced by FootprintLoad(), and GetEnumeratedFootprint().

◆ GetFootprintFileDesc()

PLUGIN_FILE_DESC GPCB_PLUGIN::GetFootprintFileDesc ( ) const

inlineoverridevirtual

Returns footprint file description for the PLUGIN.

Reimplemented from PLUGIN.

Definition at line 54 of file gpcb_plugin.h.

References _HKI.

◆ GetFootprintLibDesc()

PLUGIN_FILE_DESC GPCB_PLUGIN::GetFootprintLibDesc ( ) const

inlineoverridevirtual

Returns footprint library description for the PLUGIN.

Reimplemented from PLUGIN.

Definition at line 59 of file gpcb_plugin.h.

References _HKI.

◆ GetImportedCachedLibraryFootprints()

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

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.

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()

long long GPCB_PLUGIN::GetLibraryTimestamp ( const wxString & aLibraryPath ) const

overridevirtual

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 1046 of file gpcb_plugin.cpp.

References GPCB_FPL_CACHE::GetTimestamp().

◆ ImportFootprint()

FOOTPRINT * GPCB_PLUGIN::ImportFootprint	(	const wxString &	aFootprintPath,
		wxString &	aFootprintNameOut,
		const STRING_UTF8_MAP *	aProperties
	)

overridevirtual

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

Definition at line 837 of file gpcb_plugin.cpp.

References FootprintLoad(), LINE_READER::Line(), and WHITESPACE_FILTER_READER::ReadLine().

◆ init()

void GPCB_PLUGIN::init ( const STRING_UTF8_MAP * aProperties )

private

Definition at line 819 of file gpcb_plugin.cpp.

References m_props.

Referenced by FootprintDelete(), FootprintEnumerate(), getFootprint(), GPCB_PLUGIN(), and IsFootprintLibWritable().

◆ IsFootprintLibWritable()

bool GPCB_PLUGIN::IsFootprintLibWritable ( 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 PLUGIN.

Definition at line 1052 of file gpcb_plugin.cpp.

References init(), GPCB_FPL_CACHE::IsWritable(), m_cache, and validateCache().

◆ LoadBoard()

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

virtualinherited

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()

const wxString GPCB_PLUGIN::PluginName ( ) const

inlineoverridevirtual

Return a brief hard coded name for this PLUGIN.

Implements PLUGIN.

Definition at line 49 of file gpcb_plugin.h.

◆ PrefetchLib()

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

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.

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`
	)

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.

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 )

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

◆ validateCache()

void GPCB_PLUGIN::validateCache	(	const wxString &	aLibraryPath,
		bool	checkModified = `true`
	)

private

Definition at line 825 of file gpcb_plugin.cpp.

References GPCB_FPL_CACHE, GPCB_FPL_CACHE::IsModified(), GPCB_FPL_CACHE::Load(), and m_cache.

Referenced by FootprintDelete(), FootprintEnumerate(), getFootprint(), and IsFootprintLibWritable().

Friends And Related Function Documentation

◆ GPCB_FPL_CACHE

friend class GPCB_FPL_CACHE

friend

Definition at line 106 of file gpcb_plugin.h.

Referenced by validateCache().

Member Data Documentation

◆ m_cache

GPCB_FPL_CACHE* GPCB_PLUGIN::m_cache

protected

Footprint library cache.

Definition at line 111 of file gpcb_plugin.h.

Referenced by FootprintDelete(), FootprintEnumerate(), FootprintLibDelete(), getFootprint(), IsFootprintLibWritable(), validateCache(), and ~GPCB_PLUGIN().

◆ m_ctl

int GPCB_PLUGIN::m_ctl

protected

Definition at line 112 of file gpcb_plugin.h.

◆ m_error

wxString GPCB_PLUGIN::m_error

protected

for throwing exceptions

Definition at line 109 of file gpcb_plugin.h.

◆ m_filename

wxString GPCB_PLUGIN::m_filename

protected

for saves only, name is in m_reader for loads

Definition at line 114 of file gpcb_plugin.h.

◆ m_props

const STRING_UTF8_MAP* GPCB_PLUGIN::m_props

protected

passed via Save() or Load(), no ownership, may be NULL.

Definition at line 110 of file gpcb_plugin.h.

Referenced by init().

◆ m_reader

LINE_READER* GPCB_PLUGIN::m_reader

protected

no ownership here.

Definition at line 113 of file gpcb_plugin.h.

Referenced by GPCB_PLUGIN().

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

Public Member Functions

Protected Attributes

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ GPCB_PLUGIN() [1/2]

◆ GPCB_PLUGIN() [2/2]

◆ ~GPCB_PLUGIN()

Member Function Documentation

◆ CanReadBoard()

◆ CanReadFootprint()

◆ CanReadFootprintLib()

◆ FootprintDelete()

◆ FootprintEnumerate()

◆ FootprintExists()

◆ FootprintLibCreate()

◆ FootprintLibDelete()

◆ FootprintLibOptions()

◆ FootprintLoad()

◆ FootprintSave()

◆ GetBoardFileDesc()

◆ GetEnumeratedFootprint()

◆ getFootprint()

◆ GetFootprintFileDesc()

◆ GetFootprintLibDesc()

◆ GetImportedCachedLibraryFootprints()

◆ GetLibraryTimestamp()

◆ ImportFootprint()

◆ init()

◆ IsFootprintLibWritable()

◆ LoadBoard()

◆ PluginName()

◆ PrefetchLib()

◆ SaveBoard()

◆ SetQueryUserCallback()

◆ validateCache()

Friends And Related Function Documentation

◆ GPCB_FPL_CACHE

Member Data Documentation

◆ m_cache

◆ m_ctl

◆ m_error

◆ m_filename

◆ m_props

◆ m_reader