GPCB_PLUGIN Class Reference

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...
const wxString	GetFileExtension () const override
	Returns the file extension for the PLUGIN. 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 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 *	Load (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	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 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 832 of file gpcb_plugin.cpp.

 :
 m_cache( nullptr ),
 m_ctl( 0 )
{
 m_reader = nullptr;
 init( nullptr );
}

References init(), and m_reader.

GPCB_PLUGIN() [2/2]

GPCB_PLUGIN::GPCB_PLUGIN

(

int

aControlFlags

)

Definition at line 841 of file gpcb_plugin.cpp.

 :
 m_cache( nullptr ),
 m_ctl( aControlFlags )
{
 m_reader = nullptr;
 init( nullptr );
}

References init(), and m_reader.

~GPCB_PLUGIN()

GPCB_PLUGIN::~GPCB_PLUGIN

(

)

Definition at line 850 of file gpcb_plugin.cpp.

{
 delete m_cache;
}

References m_cache.

Member Function Documentation

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

{
 LOCALE_IO toggle; // toggles on, then off, the C locale.
 
 init( aProperties );
 
 validateCache( aLibraryPath );
 
 if( !m_cache->IsWritable() )
 {
 THROW_IO_ERROR( wxString::Format( _( "Library '%s' is read only." ),
 aLibraryPath.GetData() ) );
 }
 
 m_cache->Remove( aFootprintName );
}

References _, Format(), 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 874 of file gpcb_plugin.cpp.

{
 LOCALE_IO toggle; // toggles on, then off, the C locale.
 wxDir dir( aLibraryPath );
 wxString errorMsg;
 
 if( !dir.IsOpened() )
 {
 if( aBestEfforts )
 return;
 else
 {
 THROW_IO_ERROR( wxString::Format( _( "Footprint library '%s' not found." ),
 aLibraryPath ) );
 }
 }
 
 init( aProperties );
 
 try
 {
 validateCache( aLibraryPath );
 }
 catch( const IO_ERROR& ioe )
 {
 errorMsg = ioe.What();
 }
 
 // Some of the files may have been parsed correctly so we want to add the valid files to
 // the library.
 
 for( const auto& footprint : m_cache->GetFootprints() )
 aFootprintNames.Add( FROM_UTF8( footprint.first.c_str() ) );
 
 if( !errorMsg.IsEmpty() && !aBestEfforts )
 THROW_IO_ERROR( errorMsg );
}

References _, Format(), 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 PCB_PLUGIN.

Definition at line 89 of file plugin.cpp.

{
 // default implementation
 return FootprintLoad( aLibraryPath, aFootprintName, true, aProperties ) != nullptr;
}

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

{
 // not pure virtual so that plugins only have to implement subset of the PLUGIN interface.
 not_implemented( this, __FUNCTION__ );
}

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

{
 wxFileName fn;
 fn.SetPath( aLibraryPath );
 
 // Return if there is no library path to delete.
 if( !fn.DirExists() )
 return false;
 
 if( !fn.IsDirWritable() )
 {
 THROW_IO_ERROR( wxString::Format( _( "Insufficient permissions to delete folder '%s'." ),
 aLibraryPath.GetData() ) );
 }
 
 wxDir dir( aLibraryPath );
 
 if( dir.HasSubDirs() )
 {
 THROW_IO_ERROR( wxString::Format( _( "Library folder '%s' has unexpected sub-folders." ),
 aLibraryPath.GetData() ) );
 }
 
 // All the footprint files must be deleted before the directory can be deleted.
 if( dir.HasFiles() )
 {
 unsigned i;
 wxFileName tmp;
 wxArrayString files;
 
 wxDir::GetAllFiles( aLibraryPath, &files );
 
 for( i = 0; i < files.GetCount(); i++ )
 {
 tmp = files[i];
 
 if( tmp.GetExt() != KiCadFootprintFileExtension )
 {
 THROW_IO_ERROR( wxString::Format( _( "Unexpected file '%s' found in library '%s'." ),
 files[i].GetData(),
 aLibraryPath.GetData() ) );
 }
 }
 
 for( i = 0; i < files.GetCount(); i++ )
 {
 wxRemoveFile( files[i] );
 }
 }
 
 wxLogTrace( traceGedaPcbPlugin, wxT( "Removing footprint library '%s'" ),
 aLibraryPath.GetData() );
 
 // Some of the more elaborate wxRemoveFile() crap puts up its own wxLog dialog
 // we don't want that. we want bare metal portability with no UI here.
 if( !wxRmdir( aLibraryPath ) )
 {
 THROW_IO_ERROR( wxString::Format( _( "Footprint library '%s' cannot be deleted." ),
 aLibraryPath.GetData() ) );
 }
 
 // For some reason removing a directory in Windows is not immediately updated. This delay
 // prevents an error when attempting to immediately recreate the same directory when over
 // writing an existing library.
#ifdef __WINDOWS__
 wxMilliSleep( 250L );
#endif
 
 if( m_cache && m_cache->GetPath() == aLibraryPath )
 {
 delete m_cache;
 m_cache = nullptr;
 }
 
 return true;
}

References _, Format(), 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_FP_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 145 of file plugin.cpp.

{
 // disable all these in another couple of months, after everyone has seen them:
#if 1
 (*aListToAppendTo)["debug_level"] = UTF8( _( "Enable <b>debug</b> logging for Footprint*() "
 "functions in this PLUGIN." ) );
 
 (*aListToAppendTo)["read_filter_regex"] = UTF8( _( "Regular expression <b>footprint name</b> "
 "filter." ) );
 
 (*aListToAppendTo)["enable_transaction_logging"] = UTF8( _( "Enable transaction logging. The "
 "mere presence of this option "
 "turns on the logging, no need to "
 "set a Value." ) );
 
 (*aListToAppendTo)["username"] = UTF8( _( "User name for <b>login</b> to some special library "
  "server." ) );
 
 (*aListToAppendTo)["password"] = UTF8( _( "Password for <b>login</b> to some special library "
 "server." ) );
#endif
 
#if 1
 // Suitable for a C++ to python PLUGIN::Footprint*() adapter, move it to the adapter
 // if and when implemented.
 (*aListToAppendTo)["python_footprint_plugin"] = UTF8( _( "Enter the python module which "
 "implements the PLUGIN::Footprint*() "
 "functions." ) );
#endif
}

References _.

Referenced by DIALOG_FP_PLUGIN_OPTIONS::DIALOG_FP_PLUGIN_OPTIONS(), and EAGLE_PLUGIN::FootprintLibOptions().

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

{
 const FOOTPRINT* footprint = getFootprint( aLibraryPath, aFootprintName, aProperties, true );
 
 if( footprint )
 {
 FOOTPRINT* copy = (FOOTPRINT*) footprint->Duplicate();
 copy->SetParent( nullptr );
 return copy;
 }
 
 return nullptr;
}

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

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

{
 // not pure virtual so that plugins only have to implement subset of the PLUGIN interface.
 not_implemented( this, __FUNCTION__ );
}

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

{
 return getFootprint( aLibraryPath, aFootprintName, aProperties, false );
}

References getFootprint().

GetFileExtension()

const wxString GPCB_PLUGIN::GetFileExtension ( ) const

inlineoverridevirtual

Returns the file extension for the PLUGIN.

Implements PLUGIN.

Definition at line 54 of file gpcb_plugin.h.

 {
 return wxT( "fp" );
 }

getFootprint()

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

private

Definition at line 914 of file gpcb_plugin.cpp.

{
 LOCALE_IO toggle; // toggles on, then off, the C locale.
 
 init( aProperties );
 
 validateCache( aLibraryPath, checkModified );
 
 const FOOTPRINT_MAP& mods = m_cache->GetFootprints();
 
 FOOTPRINT_MAP::const_iterator it = mods.find( TO_UTF8( aFootprintName ) );
 
 if( it == mods.end() )
 return nullptr;
 
 return it->second->GetFootprint();
}

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

Referenced by FootprintLoad(), and GetEnumeratedFootprint().

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

{
 not_implemented( this, __FUNCTION__ );
 return std::vector<FOOTPRINT*>();
}

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

{
 return GPCB_FPL_CACHE::GetTimestamp( aLibraryPath );
}

References GPCB_FPL_CACHE::GetTimestamp().

init()

void GPCB_PLUGIN::init ( const STRING_UTF8_MAP *  aProperties )

private

Definition at line 856 of file gpcb_plugin.cpp.

{
 m_props = aProperties;
}

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

{
 LOCALE_IO toggle;
 
 init( nullptr );
 
 validateCache( aLibraryPath );
 
 return m_cache->IsWritable();
}

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

Load()

BOARD * PLUGIN::Load ( 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, CLIPBOARD_IO, CADSTAR_PCB_ARCHIVE_PLUGIN, EAGLE_PLUGIN, FABMASTER_PLUGIN, PCB_PLUGIN, LEGACY_PLUGIN, and PCAD_PLUGIN.

Definition at line 46 of file plugin.cpp.

{
 not_implemented( this, __FUNCTION__ );
 return nullptr;
}

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.

 {
 return wxT( "Geda PCB" );
 }

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

{
 // not pure virtual so that plugins only have to implement subset of the PLUGIN interface.
 not_implemented( this, __FUNCTION__ );
}

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

validateCache()

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

private

Definition at line 862 of file gpcb_plugin.cpp.

{
 if( !m_cache || ( checkModified && m_cache->IsModified() ) )
 {
 // a spectacular episode in memory management:
 delete m_cache;
 m_cache = new GPCB_FPL_CACHE( this, aLibraryPath );
 m_cache->Load();
 }
}

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 97 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 102 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 103 of file gpcb_plugin.h.

m_error

wxString GPCB_PLUGIN::m_error

protected

for throwing exceptions

Definition at line 100 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 105 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 101 of file gpcb_plugin.h.

Referenced by init().

m_reader

LINE_READER* GPCB_PLUGIN::m_reader

protected

no ownership here.

Definition at line 104 of file gpcb_plugin.h.

Referenced by GPCB_PLUGIN().

---

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

• gpcb_plugin.h
• gpcb_plugin.cpp