#include <altium_designer_plugin.h>

Inheritance diagram for ALTIUM_DESIGNER_PLUGIN:

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

BOARD *	Load (const wxString &aFileName, BOARD aAppendToMe, const STRING_UTF8_MAP aProperties, PROJECT aProject=nullptr, 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...

const wxString	GetFileExtension () const override
	Returns the file extension for the PLUGIN. More...

long long	GetLibraryTimestamp (const wxString &aLibraryPath) const override
	Generate a timestamp representing all the files in the library (including the library directory). 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...

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

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

	ALTIUM_DESIGNER_PLUGIN ()

	~ALTIUM_DESIGNER_PLUGIN ()

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	Save (const wxString &aFileName, BOARD aBoard, const STRING_UTF8_MAP 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	PrefetchLib (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr)
	If possible, prefetches the specified library (e.g. 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 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

Detailed Description

Definition at line 31 of file altium_designer_plugin.h.

Constructor & Destructor Documentation

◆ ALTIUM_DESIGNER_PLUGIN()

ALTIUM_DESIGNER_PLUGIN::ALTIUM_DESIGNER_PLUGIN ( )

Definition at line 41 of file altium_designer_plugin.cpp.

References m_board, and m_props.

◆ ~ALTIUM_DESIGNER_PLUGIN()

ALTIUM_DESIGNER_PLUGIN::~ALTIUM_DESIGNER_PLUGIN ( )

Definition at line 48 of file altium_designer_plugin.cpp.

Member Function Documentation

◆ FootprintDelete()

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

virtualinherited

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 103 of file plugin.cpp.

References NOT_IMPLEMENTED.

Referenced by FP_LIB_TABLE::FootprintDelete().

◆ FootprintEnumerate()

void ALTIUM_DESIGNER_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 139 of file altium_designer_plugin.cpp.

References _, ALTIUM_COMPOUND_FILE::FindStream(), FormatPath(), ALTIUM_PARSER::GetRemainingBytes(), ALTIUM_PARSER::HasParsingError(), ALTIUM_PARSER::Read(), ALTIUM_PARSER::ReadAndSetSubrecordLength(), ALTIUM_PARSER::ReadProperties(), ALTIUM_PARSER::ReadWxString(), ALTIUM_PARSER::SkipSubrecord(), and THROW_IO_ERROR.

◆ 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 79 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 111 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`
	)

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.

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 118 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

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 132 of file plugin.cpp.

References _.

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

◆ FootprintLoad()

FOOTPRINT * ALTIUM_DESIGNER_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 187 of file altium_designer_plugin.cpp.

References m_board, ALTIUM_PCB::ParseFootprint(), and THROW_IO_ERROR.

◆ 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 95 of file plugin.cpp.

References NOT_IMPLEMENTED.

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

◆ GetEnumeratedFootprint()

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

virtualinherited

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

Reimplemented in CADSTAR_PCB_ARCHIVE_PLUGIN, GPCB_PLUGIN, and PCB_PLUGIN.

Definition at line 70 of file plugin.cpp.

References PLUGIN::FootprintLoad().

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

◆ GetFileExtension()

const wxString ALTIUM_DESIGNER_PLUGIN::GetFileExtension ( ) const

overridevirtual

Returns the file extension for the PLUGIN.

Implements PLUGIN.

Definition at line 59 of file altium_designer_plugin.cpp.

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

Definition at line 45 of file plugin.cpp.

References NOT_IMPLEMENTED.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ GetLibraryTimestamp()

long long ALTIUM_DESIGNER_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 119 of file altium_designer_plugin.cpp.

◆ IsFootprintLibWritable()

bool ALTIUM_DESIGNER_PLUGIN::IsFootprintLibWritable ( const wxString & aLibraryPath )

inlineoverridevirtual

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 55 of file altium_designer_plugin.h.

◆ Load()

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

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.

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

Definition at line 65 of file altium_designer_plugin.cpp.

References m_board, m_props, ALTIUM_PCB::Parse(), BOARD::SetFileName(), and THROW_IO_ERROR.

◆ PluginName()

const wxString ALTIUM_DESIGNER_PLUGIN::PluginName ( ) const

overridevirtual

Return a brief hard coded name for this PLUGIN.

Implements PLUGIN.

Definition at line 53 of file altium_designer_plugin.cpp.

◆ 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 65 of file plugin.cpp.

Referenced by FP_LIB_TABLE::PrefetchLib().

◆ Save()

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

Exceptions

IO_ERROR if there is a problem saving or exporting.

Reimplemented in CLIPBOARD_IO, and PCB_PLUGIN.

Definition at line 50 of file plugin.cpp.

References NOT_IMPLEMENTED.

Referenced by 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 285 of file io_mgr.h.

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

Member Data Documentation

◆ m_board

BOARD* ALTIUM_DESIGNER_PLUGIN::m_board

private

Definition at line 64 of file altium_designer_plugin.h.

Referenced by ALTIUM_DESIGNER_PLUGIN(), FootprintLoad(), and Load().

◆ m_props

const STRING_UTF8_MAP* ALTIUM_DESIGNER_PLUGIN::m_props

private

Definition at line 63 of file altium_designer_plugin.h.

Referenced by ALTIUM_DESIGNER_PLUGIN(), and Load().

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ALTIUM_DESIGNER_PLUGIN()

◆ ~ALTIUM_DESIGNER_PLUGIN()

Member Function Documentation

◆ FootprintDelete()

◆ FootprintEnumerate()

◆ FootprintExists()

◆ FootprintLibCreate()

◆ FootprintLibDelete()

◆ FootprintLibOptions()

◆ FootprintLoad()

◆ FootprintSave()

◆ GetEnumeratedFootprint()

◆ GetFileExtension()

◆ GetImportedCachedLibraryFootprints()

◆ GetLibraryTimestamp()

◆ IsFootprintLibWritable()

◆ Load()

◆ PluginName()

◆ PrefetchLib()

◆ Save()

◆ SetQueryUserCallback()

Member Data Documentation

◆ m_board

◆ m_props