KiCad PCB EDA Suite
GPCB_PLUGIN Class Reference

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
 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 FOOTPRINTGetEnumeratedFootprint (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...
 
FOOTPRINTFootprintLoad (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 BOARDLoad (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_MAPm_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)
 
const FOOTPRINTgetFootprint (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.

832 :
833 m_cache( nullptr ),
834 m_ctl( 0 )
835{
836 m_reader = nullptr;
837 init( nullptr );
838}
void init(const STRING_UTF8_MAP *aProperties)
LINE_READER * m_reader
no ownership here.
Definition: gpcb_plugin.h:104
GPCB_FPL_CACHE * m_cache
Footprint library cache.
Definition: gpcb_plugin.h:102

References init(), and m_reader.

◆ GPCB_PLUGIN() [2/2]

GPCB_PLUGIN::GPCB_PLUGIN ( int  aControlFlags)

Definition at line 841 of file gpcb_plugin.cpp.

841 :
842 m_cache( nullptr ),
843 m_ctl( aControlFlags )
844{
845 m_reader = nullptr;
846 init( nullptr );
847}

References init(), and m_reader.

◆ ~GPCB_PLUGIN()

GPCB_PLUGIN::~GPCB_PLUGIN ( )

Definition at line 850 of file gpcb_plugin.cpp.

851{
852 delete m_cache;
853}

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

964{
965 LOCALE_IO toggle; // toggles on, then off, the C locale.
966
967 init( aProperties );
968
969 validateCache( aLibraryPath );
970
971 if( !m_cache->IsWritable() )
972 {
973 THROW_IO_ERROR( wxString::Format( _( "Library '%s' is read only." ),
974 aLibraryPath.GetData() ) );
975 }
976
977 m_cache->Remove( aFootprintName );
978}
void Remove(const wxString &aFootprintName)
bool IsWritable() const
void validateCache(const wxString &aLibraryPath, bool checkModified=true)
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:41
#define _(s)
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:38
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200

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
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.
aBestEffortsif true, don't throw on errors, just return an empty list.
Exceptions
IO_ERRORif the library cannot be found, or footprint cannot be loaded.

Reimplemented from PLUGIN.

Definition at line 874 of file gpcb_plugin.cpp.

876{
877 LOCALE_IO toggle; // toggles on, then off, the C locale.
878 wxDir dir( aLibraryPath );
879 wxString errorMsg;
880
881 if( !dir.IsOpened() )
882 {
883 if( aBestEfforts )
884 return;
885 else
886 {
887 THROW_IO_ERROR( wxString::Format( _( "Footprint library '%s' not found." ),
888 aLibraryPath ) );
889 }
890 }
891
892 init( aProperties );
893
894 try
895 {
896 validateCache( aLibraryPath );
897 }
898 catch( const IO_ERROR& ioe )
899 {
900 errorMsg = ioe.What();
901 }
902
903 // Some of the files may have been parsed correctly so we want to add the valid files to
904 // the library.
905
906 for( const auto& footprint : m_cache->GetFootprints() )
907 aFootprintNames.Add( FROM_UTF8( footprint.first.c_str() ) );
908
909 if( !errorMsg.IsEmpty() && !aBestEfforts )
910 THROW_IO_ERROR( errorMsg );
911}
FOOTPRINT_MAP & GetFootprints()
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:76
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
static wxString FROM_UTF8(const char *cstring)
Convert a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:110

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.

91{
92 // default implementation
93 return FootprintLoad( aLibraryPath, aFootprintName, true, aProperties ) != nullptr;
94}
virtual FOOTPRINT * FootprintLoad(const wxString &aLibraryPath, const wxString &aFootprintName, bool aKeepUUID=false, const STRING_UTF8_MAP *aProperties=nullptr)
Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PL...
Definition: plugin.cpp:97

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

Definition at line 122 of file plugin.cpp.

123{
124 // not pure virtual so that plugins only have to implement subset of the PLUGIN interface.
125 not_implemented( this, __FUNCTION__ );
126}
static void not_implemented(PLUGIN *aPlugin, const char *aCaller)
Throw an IO_ERROR and complains of an API function not being implemented.
Definition: plugin.cpp:38

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

982{
983 wxFileName fn;
984 fn.SetPath( aLibraryPath );
985
986 // Return if there is no library path to delete.
987 if( !fn.DirExists() )
988 return false;
989
990 if( !fn.IsDirWritable() )
991 {
992 THROW_IO_ERROR( wxString::Format( _( "Insufficient permissions to delete folder '%s'." ),
993 aLibraryPath.GetData() ) );
994 }
995
996 wxDir dir( aLibraryPath );
997
998 if( dir.HasSubDirs() )
999 {
1000 THROW_IO_ERROR( wxString::Format( _( "Library folder '%s' has unexpected sub-folders." ),
1001 aLibraryPath.GetData() ) );
1002 }
1003
1004 // All the footprint files must be deleted before the directory can be deleted.
1005 if( dir.HasFiles() )
1006 {
1007 unsigned i;
1008 wxFileName tmp;
1009 wxArrayString files;
1010
1011 wxDir::GetAllFiles( aLibraryPath, &files );
1012
1013 for( i = 0; i < files.GetCount(); i++ )
1014 {
1015 tmp = files[i];
1016
1017 if( tmp.GetExt() != KiCadFootprintFileExtension )
1018 {
1019 THROW_IO_ERROR( wxString::Format( _( "Unexpected file '%s' found in library '%s'." ),
1020 files[i].GetData(),
1021 aLibraryPath.GetData() ) );
1022 }
1023 }
1024
1025 for( i = 0; i < files.GetCount(); i++ )
1026 {
1027 wxRemoveFile( files[i] );
1028 }
1029 }
1030
1031 wxLogTrace( traceGedaPcbPlugin, wxT( "Removing footprint library '%s'" ),
1032 aLibraryPath.GetData() );
1033
1034 // Some of the more elaborate wxRemoveFile() crap puts up its own wxLog dialog
1035 // we don't want that. we want bare metal portability with no UI here.
1036 if( !wxRmdir( aLibraryPath ) )
1037 {
1038 THROW_IO_ERROR( wxString::Format( _( "Footprint library '%s' cannot be deleted." ),
1039 aLibraryPath.GetData() ) );
1040 }
1041
1042 // For some reason removing a directory in Windows is not immediately updated. This delay
1043 // prevents an error when attempting to immediately recreate the same directory when over
1044 // writing an existing library.
1045#ifdef __WINDOWS__
1046 wxMilliSleep( 250L );
1047#endif
1048
1049 if( m_cache && m_cache->GetPath() == aLibraryPath )
1050 {
1051 delete m_cache;
1052 m_cache = nullptr;
1053 }
1054
1055 return true;
1056}
wxString GetPath() const
const std::string KiCadFootprintFileExtension
const wxChar *const traceGedaPcbPlugin
Flag to enable GEDA PCB plugin debug output.

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

Definition at line 145 of file plugin.cpp.

146{
147 // disable all these in another couple of months, after everyone has seen them:
148#if 1
149 (*aListToAppendTo)["debug_level"] = UTF8( _( "Enable <b>debug</b> logging for Footprint*() "
150 "functions in this PLUGIN." ) );
151
152 (*aListToAppendTo)["read_filter_regex"] = UTF8( _( "Regular expression <b>footprint name</b> "
153 "filter." ) );
154
155 (*aListToAppendTo)["enable_transaction_logging"] = UTF8( _( "Enable transaction logging. The "
156 "mere presence of this option "
157 "turns on the logging, no need to "
158 "set a Value." ) );
159
160 (*aListToAppendTo)["username"] = UTF8( _( "User name for <b>login</b> to some special library "
161 "server." ) );
162
163 (*aListToAppendTo)["password"] = UTF8( _( "Password for <b>login</b> to some special library "
164 "server." ) );
165#endif
166
167#if 1
168 // Suitable for a C++ to python PLUGIN::Footprint*() adapter, move it to the adapter
169 // if and when implemented.
170 (*aListToAppendTo)["python_footprint_plugin"] = UTF8( _( "Enter the python module which "
171 "implements the PLUGIN::Footprint*() "
172 "functions." ) );
173#endif
174}
An 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to and fro...
Definition: utf8.h:71

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

948{
949 const FOOTPRINT* footprint = getFootprint( aLibraryPath, aFootprintName, aProperties, true );
950
951 if( footprint )
952 {
953 FOOTPRINT* copy = (FOOTPRINT*) footprint->Duplicate();
954 copy->SetParent( nullptr );
955 return copy;
956 }
957
958 return nullptr;
959}
BOARD_ITEM * Duplicate() const override
Create a copy of this BOARD_ITEM.
Definition: footprint.cpp:1844
const FOOTPRINT * getFootprint(const wxString &aLibraryPath, const wxString &aFootprintName, const STRING_UTF8_MAP *aProperties, bool checkModified)

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

Definition at line 106 of file plugin.cpp.

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

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.

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

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.

55 {
56 return wxT( "fp" );
57 }

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

918{
919 LOCALE_IO toggle; // toggles on, then off, the C locale.
920
921 init( aProperties );
922
923 validateCache( aLibraryPath, checkModified );
924
925 const FOOTPRINT_MAP& mods = m_cache->GetFootprints();
926
927 FOOTPRINT_MAP::const_iterator it = mods.find( TO_UTF8( aFootprintName ) );
928
929 if( it == mods.end() )
930 return nullptr;
931
932 return it->second->GetFootprint();
933}
std::map< wxString, FOOTPRINT * > FOOTPRINT_MAP
Definition: eagle_parser.h:50
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96

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.

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

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.

1060{
1061 return GPCB_FPL_CACHE::GetTimestamp( aLibraryPath );
1062}
static long long GetTimestamp(const wxString &aLibPath)
Generate a timestamp representing all source files in the cache (including the parent directory).

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.

857{
858 m_props = aProperties;
859}
const STRING_UTF8_MAP * m_props
passed via Save() or Load(), no ownership, may be NULL.
Definition: gpcb_plugin.h:101

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

1066{
1067 LOCALE_IO toggle;
1068
1069 init( nullptr );
1070
1071 validateCache( aLibraryPath );
1072
1073 return m_cache->IsWritable();
1074}

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
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.
aProjectis the optional PROJECT object primarily used by third party importers.
aProgressReporteran optional progress reporter
aLineCounta 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_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 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.

48{
49 not_implemented( this, __FUNCTION__ );
50 return nullptr;
51}

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.

50 {
51 return wxT( "Geda PCB" );
52 }

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

Definition at line 75 of file plugin.cpp.

76{
77}

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
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 CLIPBOARD_IO, and PCB_PLUGIN.

Definition at line 60 of file plugin.cpp.

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

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.

288 { }

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.

863{
864 if( !m_cache || ( checkModified && m_cache->IsModified() ) )
865 {
866 // a spectacular episode in memory management:
867 delete m_cache;
868 m_cache = new GPCB_FPL_CACHE( this, aLibraryPath );
869 m_cache->Load();
870 }
871}
bool IsModified()
Return true if the cache is not up-to-date.
void Load()
Save not implemented for the Geda PCB footprint library format.
friend class GPCB_FPL_CACHE
Definition: gpcb_plugin.h:97

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

◆ 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: