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

#include <pcb_io_mgr.h>

Inheritance diagram for PCB_IO_MGR:

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 { PCB_FILE_UNKNOWN = 0 , KICAD_SEXP , LEGACY , ALTIUM_CIRCUIT_MAKER , ALTIUM_CIRCUIT_STUDIO , ALTIUM_DESIGNER , CADSTAR_PCB_ARCHIVE , EAGLE , EASYEDA , EASYEDAPRO , FABMASTER , GEDA_PCB , PCAD , SOLIDWORKS_PCB , IPC2581 , FILE_TYPE_NONE }
	The set of file types that the PCB_IO_MGR knows about, and for which there has been a plugin written, in alphabetical order. More...

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

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

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

static PCB_FILE_T	FindPluginTypeFromBoardPath (const wxString &aFileName, int aCtl=0)
	Return a plugin type given a path for a board file.

static PCB_FILE_T	GuessPluginTypeFromLibPath (const wxString &aLibPath, int aCtl=0)
	Return a plugin type given a footprint library's libPath.

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::LoadBoard() function on it using the arguments passed to this function.

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.

static bool	ConvertLibrary (STRING_UTF8_MAP *aOldFileProps, const wxString &aOldFilePath, const wxString &aNewFilePath)
	Convert a schematic symbol library to the latest KiCad format.

Detailed Description

A factory which returns an instance of a #PLUGIN.

Definition at line 47 of file pcb_io_mgr.h.

Member Enumeration Documentation

◆ PCB_FILE_T

enum PCB_IO_MGR::PCB_FILE_T

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

Enumerator
PCB_FILE_UNKNOWN	0 is not a legal menu id on Mac
KICAD_SEXP	S-expression Pcbnew file format.
LEGACY	Legacy Pcbnew file formats prior to s-expression.
ALTIUM_CIRCUIT_MAKER
ALTIUM_CIRCUIT_STUDIO
ALTIUM_DESIGNER
CADSTAR_PCB_ARCHIVE
EAGLE
EASYEDA
EASYEDAPRO
FABMASTER
GEDA_PCB	Geda PCB file formats.
PCAD
SOLIDWORKS_PCB
IPC2581
FILE_TYPE_NONE

Definition at line 55 of file pcb_io_mgr.h.

Member Function Documentation

◆ ConvertLibrary()

bool PCB_IO_MGR::ConvertLibrary	(	STRING_UTF8_MAP *	aOldFileProps,
		const wxString &	aOldFilePath,
		const wxString &	aNewFilePath
	)

static

Convert a schematic symbol library to the latest KiCad format.

Definition at line 187 of file pcb_io_mgr.cpp.

References FILE_TYPE_NONE, GuessPluginTypeFromLibPath(), KICAD_SEXP, and PluginFind().

Referenced by PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), and PANEL_FP_LIB_TABLE::onMigrateLibraries().

◆ EnumFromStr()

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

static

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

Definition at line 90 of file pcb_io_mgr.cpp.

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

Referenced by FP_GRID_TRICKS::optionsEditor(), and FP_LIB_TABLE_ROW::SetType().

◆ FindPluginTypeFromBoardPath()

PCB_IO_MGR::PCB_FILE_T PCB_IO_MGR::FindPluginTypeFromBoardPath	(	const wxString &	aFileName,
		int	aCtl = `0`
	)

static

Return a plugin type given a path for a board file.

FILE_TYPE_NONE if the file is not known.

Definition at line 108 of file pcb_io_mgr.cpp.

References PCB_IO_MGR::PLUGIN_REGISTRY::AllPlugins(), FILE_TYPE_NONE, PCB_IO_MGR::PLUGIN_REGISTRY::Instance(), KICAD_SEXP, KICTL_KICAD_ONLY, KICTL_NONKICAD_ONLY, and LEGACY.

Referenced by PCB_CONTROL::AppendBoardFromFile(), BOOST_AUTO_TEST_CASE(), PCB_CONTROL::DdAppendBoard(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ GuessPluginTypeFromLibPath()

PCB_IO_MGR::PCB_FILE_T PCB_IO_MGR::GuessPluginTypeFromLibPath	(	const wxString &	aLibPath,
		int	aCtl = `0`
	)

static

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

Definition at line 132 of file pcb_io_mgr.cpp.

References PCB_IO_MGR::PLUGIN_REGISTRY::AllPlugins(), FILE_TYPE_NONE, PCB_IO_MGR::PLUGIN_REGISTRY::Instance(), KICAD_SEXP, KICTL_KICAD_ONLY, KICTL_NONKICAD_ONLY, and LEGACY.

Referenced by PCB_BASE_EDIT_FRAME::AddLibrary(), BOOST_AUTO_TEST_CASE(), ConvertLibrary(), FOOTPRINT_EDIT_FRAME::DeleteFootprintFromLibrary(), FOOTPRINT_EDIT_FRAME::DuplicateFootprint(), PCBNEW_JOBS_HANDLER::JobExportFpUpgrade(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), FOOTPRINT_EDIT_FRAME::SaveLibraryAs(), and FP_LIB_TABLE_GRID::SetValue().

◆ Load()

BOARD * PCB_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::LoadBoard() function on it using the arguments passed to this function.

After the #PLUGIN::LoadBoard() 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 156 of file pcb_io_mgr.cpp.

References FMT_NOTFOUND, PluginFind(), ShowType(), and THROW_IO_ERROR.

Referenced by LoadBoard().

◆ PluginFind()

PCB_IO * PCB_IO_MGR::PluginFind ( PCB_FILE_T aFileType )

static

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

Note: The caller owns the returned object.

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

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

Referenced by PCB_CONTROL::AppendBoardFromFile(), BOOST_AUTO_TEST_CASE(), ConvertLibrary(), PCB_BASE_EDIT_FRAME::createNewLibrary(), PCB_CONTROL::DdAppendBoard(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), FP_LIB_TABLE::FindRow(), PCB_EDIT_FRAME::GenIPC2581File(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), PCBNEW_JOBS_HANDLER::JobExportIpc2581(), Load(), DIALOG_BOARD_SETUP::onAuxiliaryAction(), PCB_EDIT_FRAME::OpenProjectFiles(), FP_GRID_TRICKS::optionsEditor(), Save(), FOOTPRINT_EDIT_FRAME::SaveLibraryAs(), PCB_EDIT_FRAME::SavePcbCopy(), and PCB_EDIT_FRAME::SavePcbFile().

◆ Save()

void PCB_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 172 of file pcb_io_mgr.cpp.

References FMT_NOTFOUND, PluginFind(), ShowType(), and THROW_IO_ERROR.

Referenced by SaveBoard().

◆ ShowType()

const wxString PCB_IO_MGR::ShowType ( PCB_FILE_T aFileType )

static

Return a brief name for a plugin given aFileType enum.

Definition at line 74 of file pcb_io_mgr.cpp.

References _, PCB_IO_MGR::PLUGIN_REGISTRY::AllPlugins(), and PCB_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::onMigrateLibraries(), PANEL_FP_LIB_TABLE::PANEL_FP_LIB_TABLE(), Save(), and FP_LIB_TABLE_GRID::SetValue().

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

◆ ConvertLibrary()

◆ EnumFromStr()

◆ FindPluginTypeFromBoardPath()

◆ GuessPluginTypeFromLibPath()

◆ Load()

◆ PluginFind()

◆ Save()

◆ ShowType()