KiCad PCB EDA Suite
GPCB_PLUGIN Class Reference

Class GPCB_PLUGIN is a PLUGIN derivation for saving and loading Geda PCB files. More...

#include <gpcb_plugin.h>

Inheritance diagram for GPCB_PLUGIN:
PLUGIN

Public Member Functions

const wxString PluginName () const override
 Function PluginName returns a brief hard coded name for this PLUGIN. More...
 
const wxString GetFileExtension () const override
 Function GetFileExtension returns the file extension for the PLUGIN. More...
 
void FootprintEnumerate (wxArrayString &aFootprintNames, const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL) override
 Return a list of footprint names contained within the library at aLibraryPath. More...
 
MODULELoadEnumeratedFootprint (const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties=NULL) override
 Function LoadEnumeratedFootprint a version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management. More...
 
MODULEFootprintLoad (const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties=NULL) override
 Function FootprintLoad loads 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 PROPERTIES *aProperties=NULL) override
 Function FootprintDelete deletes aFootprintName from the library at aLibraryPath. More...
 
bool FootprintLibDelete (const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL) override
 Function FootprintLibDelete deletes 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
 Function IsFootprintLibWritable returns true iff the library at aLibraryPath is writable. More...
 
 GPCB_PLUGIN ()
 
 GPCB_PLUGIN (int aControlFlags)
 
 ~GPCB_PLUGIN ()
 
virtual BOARDLoad (const wxString &aFileName, BOARD *aAppendToMe, const PROPERTIES *aProperties=NULL)
 Function Load loads information from some input file format that this PLUGIN implementation knows about, into either a new BOARD or an existing one. More...
 
virtual void Save (const wxString &aFileName, BOARD *aBoard, const PROPERTIES *aProperties=NULL)
 Function Save will 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 PROPERTIES *aProperties=NULL)
 Function PrefetchLib If possible, prefetches the specified library (e.g. More...
 
virtual void FootprintSave (const wxString &aLibraryPath, const MODULE *aFootprint, const PROPERTIES *aProperties=NULL)
 Function FootprintSave will write aModule to an existing library located at aLibraryPath. More...
 
virtual void FootprintLibCreate (const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL)
 Function FootprintLibCreate creates a new empty footprint library at aLibraryPath empty. More...
 
virtual void FootprintLibOptions (PROPERTIES *aListToAppendTo) const
 Function FootprintLibOptions appends supported PLUGIN options to aListToAppenTo along with internationalized descriptions. More...
 

Protected Attributes

wxString m_error
 for throwing exceptions More...
 
const PROPERTIESm_props
 passed via Save() or Load(), no ownership, may be NULL. More...
 
GPCB_FPL_CACHEm_cache
 Footprint library cache. More...
 
int m_ctl
 
LINE_READERm_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)
 
MODULEdoLoadFootprint (const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties, bool checkModified)
 
void init (const PROPERTIES *aProperties)
 

Friends

class GPCB_FPL_CACHE
 

Detailed Description

Class GPCB_PLUGIN is 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 47 of file gpcb_plugin.h.

Constructor & Destructor Documentation

GPCB_PLUGIN::GPCB_PLUGIN ( )

Definition at line 875 of file gpcb_plugin.cpp.

References init(), and m_reader.

Referenced by GetFileExtension().

875  :
876  m_cache( 0 ),
877  m_ctl( 0 )
878 {
879  m_reader = NULL;
880  init( 0 );
881 }
void init(const PROPERTIES *aProperties)
GPCB_FPL_CACHE * m_cache
Footprint library cache.
Definition: gpcb_plugin.h:96
LINE_READER * m_reader
no ownership here.
Definition: gpcb_plugin.h:98
GPCB_PLUGIN::GPCB_PLUGIN ( int  aControlFlags)

Definition at line 884 of file gpcb_plugin.cpp.

References init(), and m_reader.

884  :
885  m_cache( 0 ),
886  m_ctl( aControlFlags )
887 {
888  m_reader = NULL;
889  init( 0 );
890 }
void init(const PROPERTIES *aProperties)
GPCB_FPL_CACHE * m_cache
Footprint library cache.
Definition: gpcb_plugin.h:96
LINE_READER * m_reader
no ownership here.
Definition: gpcb_plugin.h:98
GPCB_PLUGIN::~GPCB_PLUGIN ( )

Definition at line 893 of file gpcb_plugin.cpp.

References m_cache.

Referenced by GetFileExtension().

894 {
895  delete m_cache;
896 }
GPCB_FPL_CACHE * m_cache
Footprint library cache.
Definition: gpcb_plugin.h:96

Member Function Documentation

MODULE * GPCB_PLUGIN::doLoadFootprint ( const wxString &  aLibraryPath,
const wxString &  aFootprintName,
const PROPERTIES aProperties,
bool  checkModified 
)
private

Definition at line 957 of file gpcb_plugin.cpp.

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

Referenced by FootprintLoad(), and LoadEnumeratedFootprint().

961 {
962  LOCALE_IO toggle; // toggles on, then off, the C locale.
963 
964  init( aProperties );
965 
966  validateCache( aLibraryPath, checkModified );
967 
968  const MODULE_MAP& mods = m_cache->GetModules();
969 
970  MODULE_CITER it = mods.find( TO_UTF8( aFootprintName ) );
971 
972  if( it == mods.end() )
973  {
974  return NULL;
975  }
976 
977  // copy constructor to clone the already loaded MODULE
978  return new MODULE( *it->second->GetModule() );
979 }
Class LOCALE_IO is a class that can be instantiated within a scope in which you are expecting excepti...
Definition: common.h:166
MODULE_MAP & GetModules()
void init(const PROPERTIES *aProperties)
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes...
Definition: macros.h:47
GPCB_FPL_CACHE * m_cache
Footprint library cache.
Definition: gpcb_plugin.h:96
std::map< wxString, MODULE * > MODULE_MAP
Definition: eagle_plugin.h:35
MODULE_MAP::const_iterator MODULE_CITER
void validateCache(const wxString &aLibraryPath, bool checkModified=true)
void GPCB_PLUGIN::FootprintDelete ( const wxString &  aLibraryPath,
const wxString &  aFootprintName,
const PROPERTIES aProperties = NULL 
)
overridevirtual

Function FootprintDelete deletes aFootprintName from the library at aLibraryPath.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
aFootprintNameis the name of a footprint to delete from the specified library.
aPropertiesis 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_ERRORif there is a problem finding the footprint or the library, or deleting it.

Reimplemented from PLUGIN.

Definition at line 997 of file gpcb_plugin.cpp.

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

Referenced by GetFileExtension().

999 {
1000  LOCALE_IO toggle; // toggles on, then off, the C locale.
1001 
1002  init( aProperties );
1003 
1004  validateCache( aLibraryPath );
1005 
1006  if( !m_cache->IsWritable() )
1007  {
1008  THROW_IO_ERROR( wxString::Format( _( "Library \"%s\" is read only" ),
1009  aLibraryPath.GetData() ) );
1010  }
1011 
1012  m_cache->Remove( aFootprintName );
1013 }
Class LOCALE_IO is a class that can be instantiated within a scope in which you are expecting excepti...
Definition: common.h:166
void Remove(const wxString &aFootprintName)
void init(const PROPERTIES *aProperties)
GPCB_FPL_CACHE * m_cache
Footprint library cache.
Definition: gpcb_plugin.h:96
bool IsWritable() const
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
void validateCache(const wxString &aLibraryPath, bool checkModified=true)
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:38
void GPCB_PLUGIN::FootprintEnumerate ( wxArrayString &  aFootprintNames,
const wxString &  aLibraryPath,
const PROPERTIES aProperties = NULL 
)
overridevirtual

Return a list of footprint names contained within the library at aLibraryPath.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
aPropertiesis 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.
aFootprintNamesis the array of available footprint names inside a library.
Exceptions
IO_ERRORif the library cannot be found, or footprint cannot be loaded.

Reimplemented from PLUGIN.

Definition at line 917 of file gpcb_plugin.cpp.

References Format(), FROM_UTF8(), GetChars(), GPCB_FPL_CACHE::GetModules(), init(), m_cache, THROW_IO_ERROR, validateCache(), and IO_ERROR::What().

Referenced by GetFileExtension().

920 {
921  LOCALE_IO toggle; // toggles on, then off, the C locale.
922  wxDir dir( aLibraryPath );
923 
924  if( !dir.IsOpened() )
925  {
926  THROW_IO_ERROR( wxString::Format( _( "footprint library path \"%s\" does not exist" ),
927  GetChars( aLibraryPath ) ) );
928  }
929 
930  init( aProperties );
931 
932  wxString errorMsg;
933 
934  // Some of the files may have been parsed correctly so we want to add the valid files to
935  // the library.
936  try
937  {
938  validateCache( aLibraryPath );
939  }
940  catch( const IO_ERROR& ioe )
941  {
942  errorMsg = ioe.What();
943  }
944 
945  const MODULE_MAP& mods = m_cache->GetModules();
946 
947  for( MODULE_CITER it = mods.begin(); it != mods.end(); ++it )
948  {
949  aFootprintNames.Add( FROM_UTF8( it->first.c_str() ) );
950  }
951 
952  if( !errorMsg.IsEmpty() )
953  THROW_IO_ERROR( errorMsg );
954 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes...
Definition: macros.h:53
Class LOCALE_IO is a class that can be instantiated within a scope in which you are expecting excepti...
Definition: common.h:166
MODULE_MAP & GetModules()
void init(const PROPERTIES *aProperties)
GPCB_FPL_CACHE * m_cache
Footprint library cache.
Definition: gpcb_plugin.h:96
std::map< wxString, MODULE * > MODULE_MAP
Definition: eagle_plugin.h:35
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
MODULE_MAP::const_iterator MODULE_CITER
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:92
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
void validateCache(const wxString &aLibraryPath, bool checkModified=true)
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:47
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:38
void PLUGIN::FootprintLibCreate ( const wxString &  aLibraryPath,
const PROPERTIES aProperties = NULL 
)
virtualinherited

Function FootprintLibCreate creates 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
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
aPropertiesis 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_ERRORif there is a problem finding the library, or creating it.

Reimplemented in GITHUB_PLUGIN, and PCB_IO.

Definition at line 108 of file plugin.cpp.

References not_implemented().

Referenced by PCB_BASE_EDIT_FRAME::CreateNewLibrary(), and FP_LIB_TABLE::FootprintLibCreate().

109 {
110  // not pure virtual so that plugins only have to implement subset of the PLUGIN interface.
111  not_implemented( this, __FUNCTION__ );
112 }
static void not_implemented(PLUGIN *aPlugin, const char *aCaller)
Function not_implemented throws an IO_ERROR and complains of an API function not being implemented...
Definition: plugin.cpp:38
bool GPCB_PLUGIN::FootprintLibDelete ( const wxString &  aLibraryPath,
const PROPERTIES aProperties = NULL 
)
overridevirtual

Function FootprintLibDelete deletes 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
aLibraryPathis a locator for the "library", usually a directory or file which will contain footprints.
aPropertiesis 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
bool - true if library deleted, false if library did not exist.
Exceptions
IO_ERRORif there is a problem deleting an existing library.

Reimplemented from PLUGIN.

Definition at line 1016 of file gpcb_plugin.cpp.

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

Referenced by GetFileExtension().

1017 {
1018  wxFileName fn;
1019  fn.SetPath( aLibraryPath );
1020 
1021  // Return if there is no library path to delete.
1022  if( !fn.DirExists() )
1023  return false;
1024 
1025  if( !fn.IsDirWritable() )
1026  {
1027  THROW_IO_ERROR( wxString::Format( _( "user does not have permission to delete directory \"%s\"" ),
1028  aLibraryPath.GetData() ) );
1029  }
1030 
1031  wxDir dir( aLibraryPath );
1032 
1033  if( dir.HasSubDirs() )
1034  {
1035  THROW_IO_ERROR( wxString::Format( _( "library directory \"%s\" has unexpected sub-directories" ),
1036  aLibraryPath.GetData() ) );
1037  }
1038 
1039  // All the footprint files must be deleted before the directory can be deleted.
1040  if( dir.HasFiles() )
1041  {
1042  unsigned i;
1043  wxFileName tmp;
1044  wxArrayString files;
1045 
1046  wxDir::GetAllFiles( aLibraryPath, &files );
1047 
1048  for( i = 0; i < files.GetCount(); i++ )
1049  {
1050  tmp = files[i];
1051 
1052  if( tmp.GetExt() != KiCadFootprintFileExtension )
1053  {
1054  THROW_IO_ERROR( wxString::Format( _( "unexpected file \"%s\" was found in library path \"%s\"" ),
1055  files[i].GetData(), aLibraryPath.GetData() ) );
1056  }
1057  }
1058 
1059  for( i = 0; i < files.GetCount(); i++ )
1060  {
1061  wxRemoveFile( files[i] );
1062  }
1063  }
1064 
1065  wxLogTrace( traceGedaPcbPlugin, wxT( "Removing footprint library '%s'" ),
1066  aLibraryPath.GetData() );
1067 
1068  // Some of the more elaborate wxRemoveFile() crap puts up its own wxLog dialog
1069  // we don't want that. we want bare metal portability with no UI here.
1070  if( !wxRmdir( aLibraryPath ) )
1071  {
1072  THROW_IO_ERROR( wxString::Format( _( "footprint library \"%s\" cannot be deleted" ),
1073  aLibraryPath.GetData() ) );
1074  }
1075 
1076  // For some reason removing a directory in Windows is not immediately updated. This delay
1077  // prevents an error when attempting to immediately recreate the same directory when over
1078  // writing an existing library.
1079 #ifdef __WINDOWS__
1080  wxMilliSleep( 250L );
1081 #endif
1082 
1083  if( m_cache && m_cache->GetPath() == aLibraryPath )
1084  {
1085  delete m_cache;
1086  m_cache = NULL;
1087  }
1088 
1089  return true;
1090 }
const wxChar *const traceGedaPcbPlugin
Flag to enable GEDA PCB plugin debug output.
const wxString KiCadFootprintFileExtension
wxString GetPath() const
GPCB_FPL_CACHE * m_cache
Footprint library cache.
Definition: gpcb_plugin.h:96
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
size_t i
Definition: json11.cpp:597
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:38
void PLUGIN::FootprintLibOptions ( PROPERTIES aListToAppendTo) const
virtualinherited

Function FootprintLibOptions appends 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 that since aListToAppendTo is a PROPERTIES object, all options will be unique and last guy wins.

Parameters
aListToAppendToholds 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 GITHUB_PLUGIN, and EAGLE_PLUGIN.

Definition at line 131 of file plugin.cpp.

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

132 {
133  // disable all these in another couple of months, after everyone has seen them:
134 #if 1
135  (*aListToAppendTo)["debug_level"] = UTF8( _(
136  "Enable <b>debug</b> logging for Footprint*() functions in this PLUGIN."
137  ));
138 
139  (*aListToAppendTo)["read_filter_regex"] = UTF8( _(
140  "Regular expression <b>footprint name</b> filter."
141  ));
142 
143  (*aListToAppendTo)["enable_transaction_logging"] = UTF8( _(
144  "Enable transaction logging. The mere presence of this option turns on the "
145  "logging, no need to set a Value."
146  ));
147 
148  (*aListToAppendTo)["username"] = UTF8( _(
149  "User name for <b>login</b> to some special library server."
150  ));
151 
152  (*aListToAppendTo)["password"] = UTF8( _(
153  "Password for <b>login</b> to some special library server."
154  ));
155 #endif
156 
157 #if 1
158  // Suitable for a C++ to python PLUGIN::Footprint*() adapter, move it to the adapter
159  // if and when implemented.
160  (*aListToAppendTo)["python_footprint_plugin"] = UTF8( _(
161  "Enter the python module which implements the PLUGIN::Footprint*() functions."
162  ));
163 #endif
164 }
Class UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion supp...
Definition: utf8.h:73
MODULE * GPCB_PLUGIN::FootprintLoad ( const wxString &  aLibraryPath,
const wxString &  aFootprintName,
const PROPERTIES aProperties = NULL 
)
overridevirtual

Function FootprintLoad loads a footprint having aFootprintName from the aLibraryPath containing a library format that this PLUGIN knows about.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
aFootprintNameis the name of the footprint to load.
aPropertiesis 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
MODULE* - if found caller owns it, else NULL if not found.
Exceptions
IO_ERRORif 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 990 of file gpcb_plugin.cpp.

References doLoadFootprint().

Referenced by GetFileExtension().

992 {
993  return doLoadFootprint( aLibraryPath, aFootprintName, aProperties, true );
994 }
MODULE * doLoadFootprint(const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties, bool checkModified)
void PLUGIN::FootprintSave ( const wxString &  aLibraryPath,
const MODULE aFootprint,
const PROPERTIES aProperties = NULL 
)
virtualinherited

Function FootprintSave will write aModule to an existing library located at aLibraryPath.

If a footprint by the same name already exists, it is replaced.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
aFootprintis what to store in the library. The caller continues to own the footprint after this call.
aPropertiesis 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_ERRORif there is a problem saving.

Reimplemented in GITHUB_PLUGIN, and PCB_IO.

Definition at line 94 of file plugin.cpp.

References not_implemented().

Referenced by PCB_EDIT_FRAME::ArchiveModulesOnBoard(), WIZARD_FPLIB_TABLE::checkFiles(), FP_LIB_TABLE::FootprintSave(), FOOTPRINT_EDIT_FRAME::OnSaveLibraryAs(), and FOOTPRINT_EDIT_FRAME::SaveCurrentModule().

95 {
96  // not pure virtual so that plugins only have to implement subset of the PLUGIN interface.
97  not_implemented( this, __FUNCTION__ );
98 }
static void not_implemented(PLUGIN *aPlugin, const char *aCaller)
Function not_implemented throws an IO_ERROR and complains of an API function not being implemented...
Definition: plugin.cpp:38
const wxString GPCB_PLUGIN::GetFileExtension ( ) const
inlineoverridevirtual

Function GetFileExtension returns the file extension for the PLUGIN.

Implements PLUGIN.

Definition at line 60 of file gpcb_plugin.h.

References FootprintDelete(), FootprintEnumerate(), FootprintLibDelete(), FootprintLoad(), GetLibraryTimestamp(), GPCB_PLUGIN(), IsFootprintLibWritable(), LoadEnumeratedFootprint(), and ~GPCB_PLUGIN().

61  {
62  return wxT( "fp" );
63  }
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 1093 of file gpcb_plugin.cpp.

References GPCB_FPL_CACHE::GetTimestamp(), GPCB_FPL_CACHE::IsPath(), and m_cache.

Referenced by GetFileExtension().

1094 {
1095  // If we have no cache, return a number which won't match any stored timestamps
1096  if( !m_cache || !m_cache->IsPath( aLibraryPath ) )
1097  return wxDateTime::Now().GetValue().GetValue();
1098 
1099  return m_cache->GetTimestamp();
1100 }
long long GetTimestamp()
Function GetTimestamp Generate a timestamp representing all source files in the cache (including the ...
GPCB_FPL_CACHE * m_cache
Footprint library cache.
Definition: gpcb_plugin.h:96
bool IsPath(const wxString &aPath) const
Function IsPath checks if aPath is the same as the current cache path.
void GPCB_PLUGIN::init ( const PROPERTIES aProperties)
private

Definition at line 899 of file gpcb_plugin.cpp.

References m_props.

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

900 {
901  m_props = aProperties;
902 }
const PROPERTIES * m_props
passed via Save() or Load(), no ownership, may be NULL.
Definition: gpcb_plugin.h:95
bool GPCB_PLUGIN::IsFootprintLibWritable ( const wxString &  aLibraryPath)
overridevirtual

Function IsFootprintLibWritable returns true iff the library at aLibraryPath is writable.

(Often system libraries are read only because of where they are installed.)

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
Exceptions
IO_ERRORif no library at aLibraryPath exists.

Reimplemented from PLUGIN.

Definition at line 1103 of file gpcb_plugin.cpp.

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

Referenced by GetFileExtension().

1104 {
1105  LOCALE_IO toggle;
1106 
1107  init( NULL );
1108 
1109  validateCache( aLibraryPath );
1110 
1111  return m_cache->IsWritable();
1112 }
Class LOCALE_IO is a class that can be instantiated within a scope in which you are expecting excepti...
Definition: common.h:166
void init(const PROPERTIES *aProperties)
GPCB_FPL_CACHE * m_cache
Footprint library cache.
Definition: gpcb_plugin.h:96
bool IsWritable() const
void validateCache(const wxString &aLibraryPath, bool checkModified=true)
BOARD * PLUGIN::Load ( const wxString &  aFileName,
BOARD aAppendToMe,
const PROPERTIES aProperties = NULL 
)
virtualinherited

Function Load loads 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
aFileNameis the name of the file to use as input and may be foreign in nature or native in nature.
aAppendToMeis an existing BOARD to append to, but if NULL then this means "do not append, rather load anew".
aPropertiesis 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.
Returns
BOARD* - the successfully loaded board, or the same one as aAppendToMe if aAppendToMe was not NULL, and caller owns it.
Exceptions
IO_ERRORif 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 PCB_IO, EAGLE_PLUGIN, LEGACY_PLUGIN, CLIPBOARD_IO, and PCAD_PLUGIN.

Definition at line 47 of file plugin.cpp.

References not_implemented().

Referenced by PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::AppendBoardFile(), IO_MGR::Load(), and PCB_EDIT_FRAME::OpenProjectFiles().

48 {
49  not_implemented( this, __FUNCTION__ );
50  return NULL;
51 }
static void not_implemented(PLUGIN *aPlugin, const char *aCaller)
Function not_implemented throws an IO_ERROR and complains of an API function not being implemented...
Definition: plugin.cpp:38
MODULE * GPCB_PLUGIN::LoadEnumeratedFootprint ( const wxString &  aLibraryPath,
const wxString &  aFootprintName,
const PROPERTIES aProperties = NULL 
)
overridevirtual

Function LoadEnumeratedFootprint a version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management.

Reimplemented from PLUGIN.

Definition at line 982 of file gpcb_plugin.cpp.

References doLoadFootprint().

Referenced by GetFileExtension().

985 {
986  return doLoadFootprint( aLibraryPath, aFootprintName, aProperties, false );
987 }
MODULE * doLoadFootprint(const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties, bool checkModified)
const wxString GPCB_PLUGIN::PluginName ( ) const
inlineoverridevirtual

Function PluginName returns a brief hard coded name for this PLUGIN.

Implements PLUGIN.

Definition at line 55 of file gpcb_plugin.h.

56  {
57  return wxT( "Geda PCB" );
58  }
void PLUGIN::PrefetchLib ( const wxString &  aLibraryPath,
const PROPERTIES aProperties = NULL 
)
virtualinherited

Function PrefetchLib 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
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
aPropertiesis 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_ERRORif there is an error prefetching the library.

Reimplemented in GITHUB_PLUGIN.

Definition at line 69 of file plugin.cpp.

Referenced by FP_LIB_TABLE::PrefetchLib().

70 {
71  (void) aLibraryPath;
72  (void) aProperties;
73 }
void PLUGIN::Save ( const wxString &  aFileName,
BOARD aBoard,
const PROPERTIES aProperties = NULL 
)
virtualinherited

Function Save will 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
aFileNameis the name of a file to save to on disk.
aBoardis 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.
aPropertiesis 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_ERRORif there is a problem saving or exporting.

Reimplemented in PCB_IO, and CLIPBOARD_IO.

Definition at line 54 of file plugin.cpp.

References not_implemented().

Referenced by IO_MGR::Save(), PCB_EDIT_FRAME::SavePcbCopy(), and PCB_EDIT_FRAME::SavePcbFile().

55 {
56  // not pure virtual so that plugins only have to implement subset of the PLUGIN interface.
57  not_implemented( this, __FUNCTION__ );
58 }
static void not_implemented(PLUGIN *aPlugin, const char *aCaller)
Function not_implemented throws an IO_ERROR and complains of an API function not being implemented...
Definition: plugin.cpp:38
void GPCB_PLUGIN::validateCache ( const wxString &  aLibraryPath,
bool  checkModified = true 
)
private

Definition at line 905 of file gpcb_plugin.cpp.

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

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

906 {
907  if( !m_cache || ( checkModified && m_cache->IsModified() ) )
908  {
909  // a spectacular episode in memory management:
910  delete m_cache;
911  m_cache = new GPCB_FPL_CACHE( this, aLibraryPath );
912  m_cache->Load();
913  }
914 }
GPCB_FPL_CACHE * m_cache
Footprint library cache.
Definition: gpcb_plugin.h:96
void Load()
Save not implemented for the Geda PCB footprint library format.
bool IsModified()
Function IsModified Return true if the cache is not up-to-date.
friend class GPCB_FPL_CACHE
Definition: gpcb_plugin.h:49

Friends And Related Function Documentation

friend class GPCB_FPL_CACHE
friend

Definition at line 49 of file gpcb_plugin.h.

Referenced by validateCache().

Member Data Documentation

GPCB_FPL_CACHE* GPCB_PLUGIN::m_cache
protected
int GPCB_PLUGIN::m_ctl
protected

Definition at line 97 of file gpcb_plugin.h.

wxString GPCB_PLUGIN::m_error
protected

for throwing exceptions

Definition at line 94 of file gpcb_plugin.h.

wxString GPCB_PLUGIN::m_filename
protected

for saves only, name is in m_reader for loads

Definition at line 99 of file gpcb_plugin.h.

const PROPERTIES* GPCB_PLUGIN::m_props
protected

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

Definition at line 95 of file gpcb_plugin.h.

Referenced by init().

LINE_READER* GPCB_PLUGIN::m_reader
protected

no ownership here.

Definition at line 98 of file gpcb_plugin.h.

Referenced by GPCB_PLUGIN().


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