A factory which returns an instance of a PLUGIN. More...

#include <io_mgr.h>

Classes
class	PLUGIN_REGISTRY
	Hold a list of available plugins, created using a singleton REGISTER_PLUGIN object. More...

struct	REGISTER_PLUGIN
	Register a plugin. More...

Public Types
enum	PCB_FILE_T { LEGACY , KICAD_SEXP , EAGLE , PCAD , FABMASTER , ALTIUM_DESIGNER , ALTIUM_CIRCUIT_STUDIO , ALTIUM_CIRCUIT_MAKER , CADSTAR_PCB_ARCHIVE , GEDA_PCB , FILE_TYPE_NONE }
	The set of file types that the IO_MGR knows about, and for which there has been a plugin written. More...

Static Public Member Functions
static PLUGIN *	PluginFind (PCB_FILE_T aFileType)
	Return a PLUGIN which the caller can use to import, export, save, or load design documents. More...

static void	PluginRelease (PLUGIN *aPlugin)
	Release a PLUGIN back to the system and may cause it to be unloaded from memory. More...

static const wxString	ShowType (PCB_FILE_T aFileType)
	Return a brief name for a plugin given aFileType enum. More...

static PCB_FILE_T	EnumFromStr (const wxString &aFileType)
	Return the PCB_FILE_T from the corresponding plugin type name: "kicad", "legacy", etc. More...

static const wxString	GetFileExtension (PCB_FILE_T aFileType)
	Return the file extension for aFileType. More...

static PCB_FILE_T	GuessPluginTypeFromLibPath (const wxString &aLibPath)
	Return a plugin type given a footprint library's libPath. More...

static BOARD *	Load (PCB_FILE_T aFileType, const wxString &aFileName, BOARD aAppendToMe=nullptr, const STRING_UTF8_MAP aProperties=nullptr, PROJECT aProject=nullptr, PROGRESS_REPORTER aProgressReporter=nullptr)
	Find the requested PLUGIN and if found, calls the PLUGIN::Load() function on it using the arguments passed to this function. More...

static void	Save (PCB_FILE_T aFileType, const wxString &aFileName, BOARD aBoard, const STRING_UTF8_MAP aProperties=nullptr)
	Write either a full aBoard to a storage file in a format that this implementation knows about, or it can be used to write a portion ofaBoard to a special kind of export file. More...

Detailed Description

A factory which returns an instance of a PLUGIN.

Definition at line 45 of file io_mgr.h.

Member Enumeration Documentation

◆ PCB_FILE_T

enum IO_MGR::PCB_FILE_T

The set of file types that the IO_MGR knows about, and for which there has been a plugin written.

Enumerator
LEGACY	Legacy Pcbnew file formats prior to s-expression.
KICAD_SEXP	S-expression Pcbnew file format.
EAGLE
PCAD
FABMASTER
ALTIUM_DESIGNER
ALTIUM_CIRCUIT_STUDIO
ALTIUM_CIRCUIT_MAKER
CADSTAR_PCB_ARCHIVE
GEDA_PCB	Geda PCB file formats.
FILE_TYPE_NONE

Definition at line 53 of file io_mgr.h.

 {
 LEGACY, 
 KICAD_SEXP, 
 EAGLE,
 PCAD,
 FABMASTER,
 ALTIUM_DESIGNER,
 ALTIUM_CIRCUIT_STUDIO,
 ALTIUM_CIRCUIT_MAKER,
 CADSTAR_PCB_ARCHIVE,
 GEDA_PCB, 
 // add your type here.
 
 // etc.
 
 FILE_TYPE_NONE
 };

Member Function Documentation

◆ EnumFromStr()

IO_MGR::PCB_FILE_T IO_MGR::EnumFromStr ( const wxString & aFileType )

static

Return the PCB_FILE_T from the corresponding plugin type name: "kicad", "legacy", etc.

Definition at line 93 of file io_mgr.cpp.

{
 const auto& plugins = PLUGIN_REGISTRY::Instance()->AllPlugins();
 
 for( const auto& plugin : plugins )
 {
 if ( plugin.m_name == aType )
 {
 return plugin.m_type;
 }
 }
 
 return PCB_FILE_T( -1 );
}

References IO_MGR::PLUGIN_REGISTRY::AllPlugins(), and IO_MGR::PLUGIN_REGISTRY::Instance().

Referenced by DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), and FP_LIB_TABLE_ROW::SetType().

◆ GetFileExtension()

const wxString IO_MGR::GetFileExtension ( PCB_FILE_T aFileType )

static

Return the file extension for aFileType.

Parameters

aFileType The PCB_FILE_T type.

Returns: the file extension for aFileType or an empty string if aFileType is invalid.

Definition at line 109 of file io_mgr.cpp.

{
 wxString ext = wxEmptyString;
 PLUGIN* plugin = PluginFind( aFileType );
 
 if( plugin != nullptr )
 {
 ext = plugin->GetFileExtension();
 PluginRelease( plugin );
 }
 
 return ext;
}

References PLUGIN::GetFileExtension(), PluginFind(), and PluginRelease().

Referenced by plugin_type().

◆ GuessPluginTypeFromLibPath()

IO_MGR::PCB_FILE_T IO_MGR::GuessPluginTypeFromLibPath ( const wxString & aLibPath )

static

Return a plugin type given a footprint library's libPath.

Definition at line 124 of file io_mgr.cpp.

{
 PCB_FILE_T ret = KICAD_SEXP; // default guess, unless detected otherwise.
 wxFileName fn( aLibPath );
 
 if( fn.GetExt() == LegacyFootprintLibPathExtension )
 {
 ret = LEGACY;
 }
 else if( fn.GetExt() == GedaPcbFootprintLibFileExtension )
 {
 ret = GEDA_PCB;
 }
 else if( fn.GetExt() == EagleFootprintLibPathExtension )
 {
 ret = EAGLE;
 }
 else if( fn.GetExt() == AltiumFootprintLibPathExtension )
 {
 ret = ALTIUM_DESIGNER;
 }
 
 // Test this one anyways, even though it's the default guess, to avoid
 // the wxURI instantiation below.
 // We default ret to KICAD above, because somebody might have
 // mistakenly put a pretty library into a directory other than
 // *.pretty/ with *.kicad_mod in there., and I don't want to return -1,
 // since we only claimed to be guessing.
 //
 else if( fn.GetExt() == KiCadFootprintLibPathExtension )
 {
 ret = KICAD_SEXP;
 }
 
 return ret;
}

References ALTIUM_DESIGNER, AltiumFootprintLibPathExtension, EAGLE, EagleFootprintLibPathExtension, GEDA_PCB, GedaPcbFootprintLibFileExtension, KICAD_SEXP, KiCadFootprintLibPathExtension, LEGACY, and LegacyFootprintLibPathExtension.

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), and FOOTPRINT_EDIT_FRAME::SaveLibraryAs().

◆ Load()

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

static

Find the requested PLUGIN and if found, calls the PLUGIN::Load() function on it using the arguments passed to this function.

After the PLUGIN::Load() function returns, the PLUGIN is Released() as part of this call.

Parameters

aFileType	is the PCB_FILE_T of file to load.
aFileName	is the name of the file to load.
aAppendToMe	is an existing BOARD to append to, use NULL if fresh board load is wanted.
aProperties	is an associative array that allows the caller to pass additional tuning parameters to the PLUGIN.
aProject	is the optional PROJECT object primarily used by third party importers.

Returns: the loaded BOARD object. The caller owns it an it will never NULL because exception thrown if error.

Exceptions

IO_ERROR if the PLUGIN cannot be found, file cannot be found, or file cannot be loaded.

Definition at line 162 of file io_mgr.cpp.

{
 // release the PLUGIN even if an exception is thrown.
 PLUGIN::RELEASER pi( PluginFind( aFileType ) );
 
 if( (PLUGIN*) pi ) // test pi->plugin
 {
 return pi->Load( aFileName, aAppendToMe, aProperties, aProject, aProgressReporter );
 }
 
 THROW_IO_ERROR( wxString::Format( FMT_NOTFOUND, ShowType( aFileType ).GetData() ) );
}

References FMT_NOTFOUND, Format(), PLUGIN::Load(), PluginFind(), ShowType(), and THROW_IO_ERROR.

Referenced by LoadBoard().

◆ PluginFind()

PLUGIN * IO_MGR::PluginFind ( PCB_FILE_T aFileType )

static

Return a PLUGIN which the caller can use to import, export, save, or load design documents.

The returned PLUGIN, may be reference counted, so please call PluginRelease() when you are done using the returned PLUGIN. It may or may not be code running from a DLL/DSO.

Note: The caller owns the returned object and must call PluginRelease when done using it.

Parameters

aFileType is from PCB_FILE_T and tells which plugin to find.

Returns: the plug in corresponding to aFileType or NULL if not found.

Definition at line 58 of file io_mgr.cpp.

{
 // This implementation is subject to change, any magic is allowed here.
 // The public IO_MGR API is the only pertinent public information.
 
 return PLUGIN_REGISTRY::Instance()->Create( aFileType );
}

References IO_MGR::PLUGIN_REGISTRY::Create(), and IO_MGR::PLUGIN_REGISTRY::Instance().

Referenced by PCB_CONTROL::AppendBoardFromFile(), AskLoadBoardFileName(), PCB_BASE_EDIT_FRAME::createNewLibrary(), PCB_CONTROL::DdAppendBoard(), DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), FP_LIB_TABLE::FindRow(), GetFileExtension(), Load(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), PCB_EDIT_FRAME::OpenProjectFiles(), parse_footprint_with_plugin(), Save(), FOOTPRINT_EDIT_FRAME::SaveLibraryAs(), PCB_EDIT_FRAME::SavePcbCopy(), and PCB_EDIT_FRAME::SavePcbFile().

◆ PluginRelease()

void IO_MGR::PluginRelease ( PLUGIN * aPlugin )

static

Release a PLUGIN back to the system and may cause it to be unloaded from memory.

Parameters

aPlugin is the one to be released, and which is no longer usable after calling this.

Definition at line 67 of file io_mgr.cpp.

{
 // This function is a place holder for a future point in time where
 // the plugin is a DLL/DSO. It could do reference counting, and then
 // unload the DLL/DSO when count goes to zero.
 
 delete aPlugin;
}

Referenced by GetFileExtension(), and PLUGIN::RELEASER::release().

◆ Save()

void IO_MGR::Save	(	PCB_FILE_T	aFileType,
		const wxString &	aFileName,
		BOARD *	aBoard,
		const STRING_UTF8_MAP *	aProperties = `nullptr`
	)

static

Write either a full aBoard to a storage file in a format that this implementation knows about, or it can be used to write a portion ofaBoard to a special kind of export file.

Parameters

aFileType	is the PCB_FILE_T of file to save.
aFileName	is the name of a file to save to on disk.
aBoard	is the BOARD document (data tree) to save or export to disk.
aBoard	is the 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.

Definition at line 178 of file io_mgr.cpp.

{
 // release the PLUGIN even if an exception is thrown.
 PLUGIN::RELEASER pi( PluginFind( aFileType ) );
 
 if( (PLUGIN*) pi ) // test pi->plugin
 {
 pi->Save( aFileName, aBoard, aProperties ); // virtual
 return;
 }
 
 THROW_IO_ERROR( wxString::Format( FMT_NOTFOUND, ShowType( aFileType ).GetData() ) );
}

References FMT_NOTFOUND, Format(), PluginFind(), PLUGIN::Save(), ShowType(), and THROW_IO_ERROR.

Referenced by SaveBoard().

◆ ShowType()

const wxString IO_MGR::ShowType ( PCB_FILE_T aFileType )

static

Return a brief name for a plugin given aFileType enum.

Definition at line 77 of file io_mgr.cpp.

{
 const auto& plugins = PLUGIN_REGISTRY::Instance()->AllPlugins();
 
 for( const auto& plugin : plugins )
 {
 if ( plugin.m_type == aType )
 {
 return plugin.m_name;
 }
 }
 
 return wxString::Format( _( "UNKNOWN (%d)" ), aType );
}

References _, IO_MGR::PLUGIN_REGISTRY::AllPlugins(), Format(), and IO_MGR::PLUGIN_REGISTRY::Instance().

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), PANEL_FP_LIB_TABLE::browseLibrariesHandler(), FP_LIB_TABLE_ROW::GetType(), Load(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), and Save().

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

Classes

Public Types

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ PCB_FILE_T

Member Function Documentation

◆ EnumFromStr()

◆ GetFileExtension()

◆ GuessPluginTypeFromLibPath()

◆ Load()

◆ PluginFind()

◆ PluginRelease()

◆ Save()

◆ ShowType()