KiCad PCB EDA Suite
GITHUB_PLUGIN Class Reference

Class GITHUB_PLUGIN implements a portion of pcbnew's PLUGIN interface to provide read only access to a github repo consisting of pretty footprints, and optionally provides "Copy On Write" support of edited footprints. More...

#include <github_plugin.h>

Inheritance diagram for GITHUB_PLUGIN:
PCB_IO 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 &aLibPath, bool aBestEfforts, const PROPERTIES *aProperties=NULL) override
 Return a list of footprint names contained within the library at aLibraryPath. More...
 
void PrefetchLib (const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL) override
 Function PrefetchLib If possible, prefetches the specified library (e.g. More...
 
MODULEFootprintLoad (const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties) override
 Function FootprintLoad loads a footprint having aFootprintName from the aLibraryPath containing a library format that this PLUGIN knows about. More...
 
void FootprintSave (const wxString &aLibraryPath, const MODULE *aFootprint, const PROPERTIES *aProperties=NULL) override
 Function FootprintSave will write aModule to an existing library located at aLibraryPath. 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 IsFootprintLibWritable (const wxString &aLibraryPath) override
 Function IsFootprintLibWritable returns true iff the library at aLibraryPath is writable. More...
 
long long GetLibraryTimestamp (const wxString &aLibraryPath) const override
 Generate a timestamp representing all the files in the library (including the library directory). More...
 
void FootprintLibOptions (PROPERTIES *aListToAppendTo) const override
 Function FootprintLibOptions appends supported PLUGIN options to aListToAppenTo along with internationalized descriptions. More...
 
void FootprintLibCreate (const wxString &aLibraryPath, const PROPERTIES *aProperties) override
 Function FootprintLibCreate creates a new empty footprint library at aLibraryPath empty. More...
 
bool FootprintLibDelete (const wxString &aLibraryPath, const PROPERTIES *aProperties) 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...
 
 GITHUB_PLUGIN ()
 
 ~GITHUB_PLUGIN ()
 
virtual void Save (const wxString &aFileName, BOARD *aBoard, const PROPERTIES *aProperties=NULL) override
 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...
 
BOARDLoad (const wxString &aFileName, BOARD *aAppendToMe, const PROPERTIES *aProperties=NULL) override
 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...
 
const MODULEGetEnumeratedFootprint (const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties=NULL) override
 Function GetEnumeratedFootprint a version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management. More...
 
bool FootprintExists (const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties=NULL) override
 Function FootprintExists check for the existence of a footprint. More...
 
void Format (BOARD_ITEM *aItem, int aNestLevel=0) const
 Function Format outputs aItem to aFormatter in s-expression format. More...
 
std::string GetStringOutput (bool doClear)
 
void SetOutputFormatter (OUTPUTFORMATTER *aFormatter)
 
BOARD_ITEMParse (const wxString &aClipboardSourceInput)
 

Protected Member Functions

void init (const PROPERTIES *aProperties)
 
void cacheLib (const wxString &aLibraryPath, const PROPERTIES *aProperties)
 
void remoteGetZip (const wxString &aRepoURL)
 Function remoteGetZip fetches a zip file image from a github repo synchronously. More...
 
void validateCache (const wxString &aLibraryPath, bool checkModified=true)
 
const MODULEgetFootprint (const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties, bool checkModified)
 
void formatSetup (BOARD *aBoard, int aNestLevel=0) const
 formats the board setup information More...
 
void formatGeneral (BOARD *aBoard, int aNestLevel=0) const
 formats the General section of the file More...
 
void formatBoardLayers (BOARD *aBoard, int aNestLevel=0) const
 formats the board layer information More...
 
void formatNetInformation (BOARD *aBoard, int aNestLevel=0) const
 formats the Nets and Netclasses More...
 
void formatHeader (BOARD *aBoard, int aNestLevel=0) const
 writes everything that comes before the board_items, like settings and layers etc More...
 

Static Protected Member Functions

static bool repoURL_zipURL (const wxString &aRepoURL, std::string *aZipURL)
 Function repoURL_zipURL translates a repo URL to a zipfile URL name as commonly seen on github.com. More...
 

Protected Attributes

wxString m_lib_path
 from aLibraryPath, something like https://github.com/liftoff-sr/pretty_footprints More...
 
std::string m_zip_image
 byte image of the zip file in its entirety. More...
 
GH_CACHEm_gh_cache
 
wxString m_pretty_dir
 
wxString m_error
 for throwing exceptions More...
 
BOARDm_board
 which BOARD, no ownership here More...
 
const PROPERTIESm_props
 passed via Save() or Load(), no ownership, may be NULL. More...
 
FP_CACHEm_cache
 Footprint library cache. More...
 
LINE_READERm_reader
 no ownership here. More...
 
wxString m_filename
 for saves only, name is in m_reader for loads More...
 
int m_loading_format_version
 which SEXPR_BOARD_FILE_VERSION should be Load()ed? More...
 
STRING_FORMATTER m_sf
 
OUTPUTFORMATTERm_out
 output any Format()s to this, no ownership More...
 
int m_ctl
 
PCB_PARSERm_parser
 
NETINFO_MAPPINGm_mapping
 mapping for net codes, so only not empty net codes are stored with consecutive integers as net codes More...
 

Detailed Description

Class GITHUB_PLUGIN implements a portion of pcbnew's PLUGIN interface to provide read only access to a github repo consisting of pretty footprints, and optionally provides "Copy On Write" support of edited footprints.

It could have used version 3 of the github.com API documented here:

    http://developer.github.com/v3/
    https://help.github.com/articles/creating-an-access-token-for-command-line-use

but it does not, since a better technique was discovered. Cleverly this plugin simply reads in a zip file of the repo and unzips it from RAM as needed. Therefore this "Github" plugin is read only for accessing remote pretty libraries at https://github.com.

The fp-lib-table dialog is entered via menu choice "Preferences | Library Tables". For easy options editing in the current row, click on the "Edit Options" button. The "Library Path" in the fp-lib-table row for a Github library should be set to the full https:// URL.

For example:

     https://github.com/liftoff-sr/pretty_footprints

This is typically

     https://github.com/user_name/repo_name

The "Plugin Type" should be set to "Github".

This plugin also supports "Copy On Write", a.k.a. "COW". Thus a Github library may take an optional option called allow_pretty_writing_to_this_dir. This option is essentially the "Library Path" for a local "KiCad" (pretty) type library which is combined to make up the Github library found in the same fp-lib-table row. If the option is missing, then the Github library is read only as always. If the option is present for a Github library, then any writes to this hybrid library will go to the local *.pretty directory. Note that the github.com resident portion of this hybrid COW library is always read only, meaning you cannot delete anything or modify any footprint at github directly. The aggregate library type remains "Github" in your discussions, but it consists of a local R/W portion and a remote R/O portion.

Below is an fp-lib-table entry for the case without option allow_pretty_writing_to_this_dir:

NicknameLibrary PathPlugin TypeOptions

Description

githubhttps://github.com/liftoff-sr/pretty_footprintsGithub Liftoff's GH footprints

Below is an fp-lib-table entry with the COW option given. Note the use of the environment variable ${HOME}, as an example only. The github.pretty directory is based in ${HOME}/pretty/. Anytime you use option allow_pretty_writing_to_this_dir, you will create that directory manually and it must end in extension .pretty.

NicknameLibrary PathPlugin TypeOptions

Description

githubhttps://github.com/liftoff-sr/pretty_footprintsGithub allow_pretty_writing_to_this_dir=${HOME}/pretty/github.pretty Liftoff's GH footprints

Any footprint loads will always give precedence to the local footprints found in the pretty dir given by option allow_pretty_writing_to_this_dir. So once you have written to the COW library's local directory by doing a footprint save, no github updates will be seen when loading a footprint by the same name as one for which you've written locally.

Always keep a separate local *.pretty directory for each Github library, never combine them by referring to the same directory more than once. Also, do not also use the same COW (*.pretty) directory in a "KiCad" fp-lib-table entry. This would likely create a mess. The COW directory should be manually created in advance, and the directory name must end with ".pretty". The value of the option allow_pretty_writing_to_this_dir will be path substituted with any environment variable strings embedded, just like the "Library Path" is.

What's the point of COW? It is to turbo-charge the sharing of footprints. If you periodically email your COW pretty footprint modifications to the Github repo maintainer, you can help update the Github copy. Simply email the individual *.kicad_mod files you find in your COW directories. After you've received confirmation that your changes have been committed up at github.com, you can safely delete your COW file(s) and those from github.com will flow down. Your goal should be to keep the COW file set as small as possible by contributing frequently to the shared master copies at https://github.com.

Note that if you use the module editor to delete a footprint and it is present in the COW local dir, it will get deleted from there. However, it may not be deleted from the library as a whole if the footprint of the same name also exists in the github repo. In this case deleting the local copy will simply unmask the one at the github repo. Remember, it is masked out if there is a local COW copy, since the local copy always takes precedence. And remember you cannot modify the github copy except by emailing a COW modification to the repo maintainer.

If you happen to be the repo maintainer, then the obvious solution for you is to make your COW directory be your working copy directory. From there you can push to github. And you can receive *.kicad_mod files by email and put them into your local working copy directory also and do diffs, reverting or denying when appropriate, editing when appropriate before pushing or denying the change. Ultimately you would owe the sender either a note of acceptance or denial by email.

Author
Dick Hollenbeck
Date
Original date: 10-Sep-2013

Definition at line 162 of file github_plugin.h.

Constructor & Destructor Documentation

◆ GITHUB_PLUGIN()

GITHUB_PLUGIN::GITHUB_PLUGIN ( )

Definition at line 115 of file github_plugin.cpp.

115  :
116  PCB_IO(),
117  m_gh_cache( 0 )
118 {
119 }
PCB_IO(int aControlFlags=CTL_FOR_BOARD)
GH_CACHE * m_gh_cache

◆ ~GITHUB_PLUGIN()

GITHUB_PLUGIN::~GITHUB_PLUGIN ( )

Definition at line 122 of file github_plugin.cpp.

123 {
124  delete m_gh_cache;
125 }
GH_CACHE * m_gh_cache

References m_gh_cache.

Member Function Documentation

◆ cacheLib()

void GITHUB_PLUGIN::cacheLib ( const wxString &  aLibraryPath,
const PROPERTIES aProperties 
)
protected

Definition at line 370 of file github_plugin.cpp.

371 {
372  // This is edge triggered based on a change in 'aLibraryPath',
373  // usually it does nothing. When the edge fires, m_pretty_dir is set
374  // to either:
375  // 1) empty or
376  // 2) a verified and validated, writable, *.pretty directory.
377 
378  if( !m_gh_cache || m_lib_path != aLibraryPath )
379  {
380  delete m_gh_cache;
381  m_gh_cache = 0;
382  m_pretty_dir.clear();
383 
384  if( !m_lib_path.empty() )
385  {
386  // Library path wasn't empty before - it's been changed. Flush out the prefetch cache.
387  m_zip_image.clear();
388  }
389 
390  if( aProperties )
391  {
392  UTF8 pretty_dir;
393 
394  if( aProperties->Value( PRETTY_DIR, &pretty_dir ) )
395  {
396  wxString wx_pretty_dir = pretty_dir;
397 
398  wx_pretty_dir = ExpandEnvVarSubstitutions( wx_pretty_dir, nullptr );
399 
400  wxFileName wx_pretty_fn = wx_pretty_dir;
401 
402  if( !wx_pretty_fn.IsOk() ||
403  !wx_pretty_fn.IsDirWritable() ||
404  wx_pretty_fn.GetExt() != "pretty"
405  )
406  {
407  wxString msg = wxString::Format(
408  _( "option \"%s\" for Github library \"%s\" must point to a writable directory ending with '.pretty'." ),
410  GetChars( aLibraryPath )
411  );
412 
413  THROW_IO_ERROR( msg );
414  }
415 
416  m_pretty_dir = wx_pretty_dir;
417  }
418  }
419 
420  // operator==( wxString, wxChar* ) does not exist, construct wxString once here.
421  const wxString kicad_mod( "kicad_mod" );
422 
423  //D(printf("%s: this:%p m_lib_path:'%s' aLibraryPath:'%s'\n", __func__, this, TO_UTF8( m_lib_path), TO_UTF8(aLibraryPath) );)
424  m_gh_cache = new GH_CACHE();
425 
426  // INIT_LOGGER( "/tmp", "test.log" );
427  remoteGetZip( aLibraryPath );
428  // UNINIT_LOGGER();
429 
430  m_lib_path = aLibraryPath;
431 
432  wxMemoryInputStream mis( &m_zip_image[0], m_zip_image.size() );
433 
434  // Recently the zip standard adopted UTF8 encoded filenames within the
435  // internal zip directory block. Please only use zip files that conform
436  // to that standard. Github seems to now, but may not have earlier.
437  wxZipInputStream zis( mis, wxConvUTF8 );
438 
439  wxZipEntry* entry;
440  wxString fp_name;
441 
442  while( ( entry = zis.GetNextEntry() ) != NULL )
443  {
444  wxFileName fn( entry->GetName() ); // chop long name into parts
445 
446  if( fn.GetExt() == kicad_mod )
447  {
448  fp_name = fn.GetName(); // omit extension & path
449 
450  m_gh_cache->insert( fp_name, entry );
451  }
452  else
453  delete entry;
454  }
455  }
456 }
UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to...
Definition: utf8.h:73
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:114
const wxString ExpandEnvVarSubstitutions(const wxString &aString, PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition: common.cpp:574
std::string m_zip_image
byte image of the zip file in its entirety.
#define NULL
wxString m_lib_path
from aLibraryPath, something like https://github.com/liftoff-sr/pretty_footprints
#define THROW_IO_ERROR(msg)
wxString m_pretty_dir
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:153
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
#define _(s)
Definition: 3d_actions.cpp:33
void remoteGetZip(const wxString &aRepoURL)
Function remoteGetZip fetches a zip file image from a github repo synchronously.
GH_CACHE * m_gh_cache
GH_CACHE assists only within GITHUB_PLUGIN and holds a map of footprint name to wxZipEntry.
bool Value(const char *aName, UTF8 *aFetchedValue=NULL) const
Function Value fetches a property by aName and returns true if that property was found,...
Definition: properties.cpp:24
static const char * PRETTY_DIR

References _, ExpandEnvVarSubstitutions(), Format(), FROM_UTF8(), GetChars(), m_gh_cache, m_lib_path, m_pretty_dir, m_zip_image, NULL, PRETTY_DIR, remoteGetZip(), THROW_IO_ERROR, and PROPERTIES::Value().

Referenced by FootprintDelete(), FootprintEnumerate(), FootprintLibCreate(), FootprintLibDelete(), FootprintLoad(), and FootprintSave().

◆ FootprintDelete()

void GITHUB_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 281 of file github_plugin.cpp.

283 {
284  // set m_pretty_dir to either empty or something in aProperties
285  cacheLib( aLibraryPath, aProperties );
286 
287  if( GITHUB_PLUGIN::IsFootprintLibWritable( aLibraryPath ) )
288  {
289  // Does the PCB_IO base class have this footprint?
290  // We cannot write to github.
291 
292  wxArrayString pretties;
293 
294  PCB_IO::FootprintEnumerate( pretties, m_pretty_dir, aProperties );
295 
296  if( pretties.Index( aFootprintName ) != wxNOT_FOUND )
297  {
298  PCB_IO::FootprintDelete( m_pretty_dir, aFootprintName, aProperties );
299  }
300  else
301  {
302  wxString msg = wxString::Format(
303  _( "Footprint\n\"%s\"\nis not in the writable portion of this Github library\n\"%s\"" ),
304  GetChars( aFootprintName ),
305  GetChars( aLibraryPath )
306  );
307 
308  THROW_IO_ERROR( msg );
309  }
310  }
311  else
312  {
313  // This typically will not happen if the caller first properly calls
314  // IsFootprintLibWritable() to determine if calling FootprintSave() is
315  // even legal, so I spend no time on internationalization here:
316 
317  string msg = StrPrintf( "Github library\n\"%s\"\nis only writable if you set option \"%s\" in Library Tables dialog.",
318  TO_UTF8( aLibraryPath ), PRETTY_DIR );
319 
320  THROW_IO_ERROR( msg );
321  }
322 }
int StrPrintf(std::string *aResult, const char *aFormat,...)
Function StrPrintf is like sprintf() but the output is appended to a std::string instead of to a char...
Definition: richio.cpp:74
void cacheLib(const wxString &aLibraryPath, const PROPERTIES *aProperties)
#define THROW_IO_ERROR(msg)
wxString m_pretty_dir
void FootprintDelete(const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties=NULL) override
Function FootprintDelete deletes aFootprintName from the library at aLibraryPath.
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:153
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
#define _(s)
Definition: 3d_actions.cpp:33
bool IsFootprintLibWritable(const wxString &aLibraryPath) override
Function IsFootprintLibWritable returns true iff the library at aLibraryPath is writable.
void FootprintEnumerate(wxArrayString &aFootprintNames, const wxString &aLibraryPath, bool aBestEfforts, const PROPERTIES *aProperties=NULL) override
Return a list of footprint names contained within the library at aLibraryPath.
#define TO_UTF8(wxstring)
static const char * PRETTY_DIR

References _, cacheLib(), PCB_IO::FootprintDelete(), PCB_IO::FootprintEnumerate(), Format(), GetChars(), IsFootprintLibWritable(), m_pretty_dir, PRETTY_DIR, numEval::StrPrintf(), THROW_IO_ERROR, and TO_UTF8.

◆ FootprintEnumerate()

void GITHUB_PLUGIN::FootprintEnumerate ( wxArrayString &  aFootprintNames,
const wxString &  aLibraryPath,
bool  aBestEfforts,
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.
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 140 of file github_plugin.cpp.

142 {
143  try
144  {
145  //D(printf("%s: this:%p aLibPath:\"%s\"\n", __func__, this, TO_UTF8(aLibraryPath) );)
146  cacheLib( aLibPath, aProperties );
147 
148  typedef std::set<wxString> MYSET;
149 
150  MYSET unique;
151 
152  if( m_pretty_dir.size() )
153  {
154  wxArrayString locals;
155 
156  PCB_IO::FootprintEnumerate( locals, m_pretty_dir, aBestEfforts );
157 
158  for( unsigned i=0; i<locals.GetCount(); ++i )
159  unique.insert( locals[i] );
160  }
161 
162  for( MODULE_ITER it = m_gh_cache->begin(); it!=m_gh_cache->end(); ++it )
163  unique.insert( it->first );
164 
165  for( MYSET::const_iterator it = unique.begin(); it != unique.end(); ++it )
166  aFootprintNames.Add( *it );
167  }
168  catch( const IO_ERROR& ioe )
169  {
170  if( !aBestEfforts )
171  throw ioe;
172  }
173 }
MODULE_MAP::iterator MODULE_ITER
void cacheLib(const wxString &aLibraryPath, const PROPERTIES *aProperties)
wxString m_pretty_dir
void FootprintEnumerate(wxArrayString &aFootprintNames, const wxString &aLibraryPath, bool aBestEfforts, const PROPERTIES *aProperties=NULL) override
Return a list of footprint names contained within the library at aLibraryPath.
GH_CACHE * m_gh_cache
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76

References cacheLib(), PCB_IO::FootprintEnumerate(), m_gh_cache, and m_pretty_dir.

◆ FootprintExists()

bool PCB_IO::FootprintExists ( const wxString &  aLibraryPath,
const wxString &  aFootprintName,
const PROPERTIES aProperties = NULL 
)
overridevirtualinherited

Function FootprintExists check for the existence of a footprint.

Reimplemented from PLUGIN.

Definition at line 2053 of file kicad_plugin.cpp.

2055 {
2056  // Note: checking the cache sounds like a good idea, but won't catch files which differ
2057  // only in case.
2058  //
2059  // Since this goes out to the native filesystem, we get platform differences (ie: MSW's
2060  // case-insensitive filesystem) handled "for free".
2061  // Warning: footprint names frequently contain a point. So be careful when initializing
2062  // wxFileName, and use a CTOR with extension specified
2063  wxFileName footprintFile( aLibraryPath, aFootprintName, KiCadFootprintFileExtension );
2064 
2065  return footprintFile.Exists();
2066 }
const std::string KiCadFootprintFileExtension

References KiCadFootprintFileExtension.

◆ FootprintLibCreate()

void GITHUB_PLUGIN::FootprintLibCreate ( const wxString &  aLibraryPath,
const PROPERTIES aProperties 
)
overridevirtual

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 from PLUGIN.

Definition at line 325 of file github_plugin.cpp.

326 {
327  // set m_pretty_dir to either empty or something in aProperties
328  cacheLib( aLibraryPath, aProperties );
329 
330  if( m_pretty_dir.size() )
332 }
void FootprintLibCreate(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL) override
Function FootprintLibCreate creates a new empty footprint library at aLibraryPath empty.
void cacheLib(const wxString &aLibraryPath, const PROPERTIES *aProperties)
wxString m_pretty_dir

References cacheLib(), PCB_IO::FootprintLibCreate(), and m_pretty_dir.

◆ FootprintLibDelete()

bool GITHUB_PLUGIN::FootprintLibDelete ( const wxString &  aLibraryPath,
const PROPERTIES aProperties 
)
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 335 of file github_plugin.cpp.

336 {
337  // set m_pretty_dir to either empty or something in aProperties
338  cacheLib( aLibraryPath, aProperties );
339 
340  if( m_pretty_dir.size() )
341  return PCB_IO::FootprintLibDelete( m_pretty_dir, aProperties );
342 
343  return false;
344 }
void cacheLib(const wxString &aLibraryPath, const PROPERTIES *aProperties)
wxString m_pretty_dir
bool FootprintLibDelete(const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL) override
Function FootprintLibDelete deletes an existing footprint library and returns true,...

References cacheLib(), PCB_IO::FootprintLibDelete(), and m_pretty_dir.

◆ FootprintLibOptions()

void GITHUB_PLUGIN::FootprintLibOptions ( PROPERTIES aListToAppendTo) const
overridevirtual

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 from PLUGIN.

Definition at line 347 of file github_plugin.cpp.

348 {
349  // inherit options supported by all PLUGINs.
350  PLUGIN::FootprintLibOptions( aListToAppendTo );
351 
352  (*aListToAppendTo)[ PRETTY_DIR ] = UTF8( _(
353  "Set this property to a directory where footprints are to be written as pretty "
354  "footprints when saving to this library. Anything saved will take precedence over "
355  "footprints by the same name in the github repo. These saved footprints can then "
356  "be sent to the library maintainer as updates. "
357  "<p>The directory <b>must</b> have a <b>.pretty</b> file extension because the "
358  "format of the save is pretty.</p>"
359  ));
360 
361  /*
362  (*aListToAppendTo)["cache_github_zip_in_this_dir"] = UTF8( _(
363  "Set this property to a directory where the github *.zip file will be cached. "
364  "This should speed up subsequent visits to this library."
365  ));
366  */
367 }
UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to...
Definition: utf8.h:73
virtual void FootprintLibOptions(PROPERTIES *aListToAppendTo) const
Function FootprintLibOptions appends supported PLUGIN options to aListToAppenTo along with internatio...
Definition: plugin.cpp:140
#define _(s)
Definition: 3d_actions.cpp:33
static const char * PRETTY_DIR

References _, PLUGIN::FootprintLibOptions(), and PRETTY_DIR.

◆ FootprintLoad()

MODULE * GITHUB_PLUGIN::FootprintLoad ( const wxString &  aLibraryPath,
const wxString &  aFootprintName,
const PROPERTIES aProperties 
)
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 188 of file github_plugin.cpp.

190 {
191  // D(printf("%s: this:%p aLibraryPath:\"%s\"\n", __func__, this, TO_UTF8(aLibraryPath) );)
192 
193  // clear or set to valid the variable m_pretty_dir
194  cacheLib( aLibraryPath, aProperties );
195 
196  if( m_pretty_dir.size() )
197  {
198  // API has FootprintLoad() *not* throwing an exception if footprint not found.
199  MODULE* local = PCB_IO::FootprintLoad( m_pretty_dir, aFootprintName, aProperties );
200 
201  if( local )
202  {
203  // It has worked, see <src>/scripts/test_kicad_plugin.py. So this was not firing:
204  // wxASSERT( aFootprintName == FROM_UTF8( local->GetFPID().GetLibItemName().c_str() ) );
205  // Moving it to higher API layer FP_LIB_TABLE::FootprintLoad().
206 
207  return local;
208  }
209  }
210 
211  MODULE_CITER it = m_gh_cache->find( aFootprintName );
212 
213  if( it != m_gh_cache->end() ) // fp_name is present
214  {
215  //std::string::data() ensures that the referenced data block is contiguous.
216  wxMemoryInputStream mis( m_zip_image.data(), m_zip_image.size() );
217 
218  // This decoder should always be UTF8, since it was saved that way by git.
219  // That is, since pretty footprints are UTF8, and they were pushed to the
220  // github repo, they are still UTF8.
221  wxZipInputStream zis( mis, wxConvUTF8 );
222  wxZipEntry* entry = (wxZipEntry*) it->second; // remove "const"-ness
223 
224  if( zis.OpenEntry( *entry ) )
225  {
226  INPUTSTREAM_LINE_READER reader( &zis, aLibraryPath );
227 
228  // I am a PCB_IO derivative with my own PCB_PARSER
229  m_parser->SetLineReader( &reader ); // ownership not passed
230 
231  MODULE* ret = (MODULE*) m_parser->Parse();
232 
233  // In a github library, (as well as in a "KiCad" library) the name of
234  // the pretty file defines the footprint name. That filename trumps
235  // any name found in the pretty file; any name in the pretty file
236  // must be ignored here. Also, the library nickname is unknown in
237  // this context so clear it just in case.
238  ret->SetFPID( LIB_ID( wxEmptyString, aFootprintName ) );
239 
240  return ret;
241  }
242  }
243 
244  return NULL; // this API function returns NULL for "not found", per spec.
245 }
INPUTSTREAM_LINE_READER is a LINE_READER that reads from a wxInputStream object.
Definition: richio.h:290
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
std::string m_zip_image
byte image of the zip file in its entirety.
#define NULL
MODULE * FootprintLoad(const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties=NULL) override
Function FootprintLoad loads a footprint having aFootprintName from the aLibraryPath containing a lib...
void cacheLib(const wxString &aLibraryPath, const PROPERTIES *aProperties)
wxString m_pretty_dir
PCB_PARSER * m_parser
BOARD_ITEM * Parse()
Definition: pcb_parser.cpp:481
LINE_READER * SetLineReader(LINE_READER *aReader)
Function SetLineReader sets aLineReader into the parser, and returns the previous one,...
Definition: pcb_parser.h:335
MODULE_MAP::const_iterator MODULE_CITER
GH_CACHE * m_gh_cache
void SetFPID(const LIB_ID &aFPID)
Definition: class_module.h:216

References cacheLib(), PCB_IO::FootprintLoad(), m_gh_cache, PCB_IO::m_parser, m_pretty_dir, m_zip_image, NULL, PCB_PARSER::Parse(), MODULE::SetFPID(), and PCB_PARSER::SetLineReader().

◆ FootprintSave()

void GITHUB_PLUGIN::FootprintSave ( const wxString &  aLibraryPath,
const MODULE aFootprint,
const PROPERTIES aProperties = NULL 
)
overridevirtual

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 from PLUGIN.

Definition at line 257 of file github_plugin.cpp.

259 {
260  // set m_pretty_dir to either empty or something in aProperties
261  cacheLib( aLibraryPath, aProperties );
262 
263  if( GITHUB_PLUGIN::IsFootprintLibWritable( aLibraryPath ) )
264  {
265  PCB_IO::FootprintSave( m_pretty_dir, aFootprint, aProperties );
266  }
267  else
268  {
269  // This typically will not happen if the caller first properly calls
270  // IsFootprintLibWritable() to determine if calling FootprintSave() is
271  // even legal, so I spend no time on internationalization here:
272 
273  string msg = StrPrintf( "Github library\n\"%s\"\nis only writable if you set option \"%s\" in Library Tables dialog.",
274  TO_UTF8( aLibraryPath ), PRETTY_DIR );
275 
276  THROW_IO_ERROR( msg );
277  }
278 }
int StrPrintf(std::string *aResult, const char *aFormat,...)
Function StrPrintf is like sprintf() but the output is appended to a std::string instead of to a char...
Definition: richio.cpp:74
void FootprintSave(const wxString &aLibraryPath, const MODULE *aFootprint, const PROPERTIES *aProperties=NULL) override
Function FootprintSave will write aModule to an existing library located at aLibraryPath.
void cacheLib(const wxString &aLibraryPath, const PROPERTIES *aProperties)
#define THROW_IO_ERROR(msg)
wxString m_pretty_dir
bool IsFootprintLibWritable(const wxString &aLibraryPath) override
Function IsFootprintLibWritable returns true iff the library at aLibraryPath is writable.
#define TO_UTF8(wxstring)
static const char * PRETTY_DIR

References cacheLib(), PCB_IO::FootprintSave(), IsFootprintLibWritable(), m_pretty_dir, PRETTY_DIR, numEval::StrPrintf(), THROW_IO_ERROR, and TO_UTF8.

◆ Format()

void PCB_IO::Format ( BOARD_ITEM aItem,
int  aNestLevel = 0 
) const
inherited

Function Format outputs aItem to aFormatter in s-expression format.

Parameters
aItemA pointer the an BOARD_ITEM object to format.
aNestLevelThe indentation nest level.
Exceptions
IO_ERRORon write error.

Definition at line 400 of file kicad_plugin.cpp.

401 {
402  LOCALE_IO toggle; // public API function, perform anything convenient for caller
403 
404  switch( aItem->Type() )
405  {
406  case PCB_T:
407  format( static_cast<BOARD*>( aItem ), aNestLevel );
408  break;
409 
410  case PCB_DIMENSION_T:
411  format( static_cast<DIMENSION*>( aItem ), aNestLevel );
412  break;
413 
414  case PCB_LINE_T:
415  format( static_cast<DRAWSEGMENT*>( aItem ), aNestLevel );
416  break;
417 
418  case PCB_MODULE_EDGE_T:
419  format( static_cast<EDGE_MODULE*>( aItem ), aNestLevel );
420  break;
421 
422  case PCB_TARGET_T:
423  format( static_cast<PCB_TARGET*>( aItem ), aNestLevel );
424  break;
425 
426  case PCB_MODULE_T:
427  format( static_cast<MODULE*>( aItem ), aNestLevel );
428  break;
429 
430  case PCB_PAD_T:
431  format( static_cast<D_PAD*>( aItem ), aNestLevel );
432  break;
433 
434  case PCB_TEXT_T:
435  format( static_cast<TEXTE_PCB*>( aItem ), aNestLevel );
436  break;
437 
438  case PCB_MODULE_TEXT_T:
439  format( static_cast<TEXTE_MODULE*>( aItem ), aNestLevel );
440  break;
441 
442  case PCB_TRACE_T:
443  case PCB_ARC_T:
444  case PCB_VIA_T:
445  format( static_cast<TRACK*>( aItem ), aNestLevel );
446  break;
447 
449  case PCB_ZONE_AREA_T:
450  format( static_cast<ZONE_CONTAINER*>( aItem ), aNestLevel );
451  break;
452 
453  default:
454  wxFAIL_MSG( wxT( "Cannot format item " ) + aItem->GetClass() );
455  }
456 }
Definition: typeinfo.h:85
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
class ZONE_CONTAINER, a zone area
Definition: typeinfo.h:102
class TEXTE_PCB, text on a layer
Definition: typeinfo.h:92
class ARC, an arc track segment on a copper layer
Definition: typeinfo.h:98
class D_PAD, a pad in a footprint
Definition: typeinfo.h:90
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:94
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
class MODULE, a footprint
Definition: typeinfo.h:89
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:100
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:101
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:93
virtual wxString GetClass() const =0
Function GetClass returns the class name.
void format(BOARD *aBoard, int aNestLevel=0) const
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
class ZONE_CONTAINER, managed by a footprint
Definition: typeinfo.h:95
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References PCB_IO::format(), EDA_ITEM::GetClass(), PCB_ARC_T, PCB_DIMENSION_T, PCB_LINE_T, PCB_MODULE_EDGE_T, PCB_MODULE_T, PCB_MODULE_TEXT_T, PCB_MODULE_ZONE_AREA_T, PCB_PAD_T, PCB_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_AREA_T, and EDA_ITEM::Type().

Referenced by FOOTPRINT_EDIT_FRAME::Export_Module(), PCB_IO::format(), CLIPBOARD_IO::Save(), PCB_IO::Save(), FP_CACHE::Save(), and CLIPBOARD_IO::SaveSelection().

◆ formatBoardLayers()

void PCB_IO::formatBoardLayers ( BOARD aBoard,
int  aNestLevel = 0 
) const
protectedinherited

formats the board layer information

Definition at line 523 of file kicad_plugin.cpp.

524 {
525  m_out->Print( aNestLevel, "(layers\n" );
526 
527  // Save only the used copper layers from front to back.
528 
529  for( LSEQ cu = aBoard->GetEnabledLayers().CuStack(); cu; ++cu )
530  {
531  PCB_LAYER_ID layer = *cu;
532 
533  m_out->Print( aNestLevel+1, "(%d %s %s", layer,
534  m_out->Quotew( aBoard->GetLayerName( layer ) ).c_str(),
535  LAYER::ShowType( aBoard->GetLayerType( layer ) ) );
536 
537  m_out->Print( 0, ")\n" );
538  }
539 
540  // Save used non-copper layers in the order they are defined.
541  // desired sequence for non Cu BOARD layers.
542  static const PCB_LAYER_ID non_cu[] =
543  {
544  B_Adhes, // 32
545  F_Adhes,
546  B_Paste,
547  F_Paste,
548  B_SilkS,
549  F_SilkS,
550  B_Mask,
551  F_Mask,
552  Dwgs_User,
553  Cmts_User,
554  Eco1_User,
555  Eco2_User,
556  Edge_Cuts,
557  Margin,
558  B_CrtYd,
559  F_CrtYd,
560  B_Fab,
561  F_Fab
562  };
563 
564  for( LSEQ seq = aBoard->GetEnabledLayers().Seq( non_cu, arrayDim( non_cu ) ); seq; ++seq )
565  {
566  PCB_LAYER_ID layer = *seq;
567 
568  m_out->Print( aNestLevel+1, "(%d %s user", layer,
569  m_out->Quotew( aBoard->GetLayerName( layer ) ).c_str() );
570 
571  m_out->Print( 0, ")\n" );
572  }
573 
574  m_out->Print( aNestLevel, ")\n\n" );
575 }
OUTPUTFORMATTER * m_out
output any Format()s to this, no ownership
LSEQ CuStack() const
Function CuStack returns a sequence of copper layers in starting from the front/top and extending to ...
Definition: lset.cpp:155
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Function GetLayerName returns the name of a layer.
LSET GetEnabledLayers() const
Function GetEnabledLayers is a proxy function that calls the corresponding function in m_BoardSetting...
LSEQ Seq(const PCB_LAYER_ID *aWishListSequence, unsigned aCount) const
Function Seq returns an LSEQ from the union of this LSET and a desired sequence.
Definition: lset.cpp:377
static const char * ShowType(LAYER_T aType)
Function ShowType converts a LAYER_T enum to a const char*.
PCB_LAYER_ID
A quick note on layer IDs:
std::string Quotew(const wxString &aWrapee)
Definition: richio.cpp:472
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:160
LAYER_T GetLayerType(PCB_LAYER_ID aLayer) const
Function GetLayerType returns the type of the copper layer given by aLayer.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404

References arrayDim(), B_Adhes, B_CrtYd, B_Fab, B_Mask, B_Paste, B_SilkS, Cmts_User, LSET::CuStack(), Dwgs_User, Eco1_User, Eco2_User, Edge_Cuts, F_Adhes, F_CrtYd, F_Fab, F_Mask, F_Paste, F_SilkS, BOARD::GetEnabledLayers(), BOARD::GetLayerName(), BOARD::GetLayerType(), PCB_IO::m_out, Margin, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), LSET::Seq(), and LAYER::ShowType().

Referenced by PCB_IO::formatHeader(), and CLIPBOARD_IO::SaveSelection().

◆ formatGeneral()

void PCB_IO::formatGeneral ( BOARD aBoard,
int  aNestLevel = 0 
) const
protectedinherited

formats the General section of the file

Definition at line 502 of file kicad_plugin.cpp.

503 {
504  const BOARD_DESIGN_SETTINGS& dsnSettings = aBoard->GetDesignSettings();
505 
506  m_out->Print( 0, "\n" );
507  m_out->Print( aNestLevel, "(general\n" );
508  // Write Bounding box info
509  m_out->Print( aNestLevel+1, "(thickness %s)\n",
510  FormatInternalUnits( dsnSettings.GetBoardThickness() ).c_str() );
511 
512  m_out->Print( aNestLevel+1, "(drawings %u)\n", (unsigned)aBoard->Drawings().size() );
513  m_out->Print( aNestLevel + 1, "(tracks %u)\n", (unsigned)aBoard->Tracks().size() );
514  m_out->Print( aNestLevel + 1, "(modules %u)\n", (unsigned)aBoard->Modules().size() );
515  m_out->Print( aNestLevel+1, "(nets %d)\n", m_mapping->GetSize() );
516  m_out->Print( aNestLevel, ")\n\n" );
517 
518  aBoard->GetPageSettings().Format( m_out, aNestLevel, m_ctl );
519  aBoard->GetTitleBlock().Format( m_out, aNestLevel, m_ctl );
520 }
OUTPUTFORMATTER * m_out
output any Format()s to this, no ownership
const PAGE_INFO & GetPageSettings() const
Definition: class_board.h:572
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:551
void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
Function GetStandardSizes returns the standard page types, such as "A4", "A3", etc.
Definition: page_info.cpp:267
int GetSize() const
Function GetSize.
Definition: netinfo.h:375
MODULES & Modules()
Definition: class_board.h:266
virtual void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
Function Format outputs the object to aFormatter in s-expression form.
Definition: ws_painter.cpp:217
NETINFO_MAPPING * m_mapping
mapping for net codes, so only not empty net codes are stored with consecutive integers as net codes
TITLE_BLOCK & GetTitleBlock()
Definition: class_board.h:578
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
DRAWINGS & Drawings()
Definition: class_board.h:275
TRACKS & Tracks()
Definition: class_board.h:257
std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from internal units to a string appropriate for writing ...
Definition: base_units.cpp:560
BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.

References BOARD::Drawings(), TITLE_BLOCK::Format(), PAGE_INFO::Format(), FormatInternalUnits(), BOARD_DESIGN_SETTINGS::GetBoardThickness(), BOARD::GetDesignSettings(), BOARD::GetPageSettings(), NETINFO_MAPPING::GetSize(), BOARD::GetTitleBlock(), PCB_IO::m_ctl, PCB_IO::m_mapping, PCB_IO::m_out, BOARD::Modules(), OUTPUTFORMATTER::Print(), and BOARD::Tracks().

Referenced by PCB_IO::formatHeader().

◆ formatHeader()

void PCB_IO::formatHeader ( BOARD aBoard,
int  aNestLevel = 0 
) const
protectedinherited

writes everything that comes before the board_items, like settings and layers etc

Definition at line 591 of file kicad_plugin.cpp.

592 {
593  formatGeneral( aBoard, aNestLevel );
594  // Layers list.
595  formatBoardLayers( aBoard, aNestLevel );
596 
597  // Setup
598  formatSetup( aBoard, aNestLevel );
599 
600  // Save net codes and names
601  formatNetInformation( aBoard, aNestLevel );
602 }
void formatGeneral(BOARD *aBoard, int aNestLevel=0) const
formats the General section of the file
void formatNetInformation(BOARD *aBoard, int aNestLevel=0) const
formats the Nets and Netclasses
void formatSetup(BOARD *aBoard, int aNestLevel=0) const
formats the board setup information
void formatBoardLayers(BOARD *aBoard, int aNestLevel=0) const
formats the board layer information

References PCB_IO::formatBoardLayers(), PCB_IO::formatGeneral(), PCB_IO::formatNetInformation(), and PCB_IO::formatSetup().

Referenced by PCB_IO::format().

◆ formatNetInformation()

void PCB_IO::formatNetInformation ( BOARD aBoard,
int  aNestLevel = 0 
) const
protectedinherited

formats the Nets and Netclasses

Definition at line 578 of file kicad_plugin.cpp.

579 {
580  for( NETINFO_ITEM* net : *m_mapping )
581  {
582  m_out->Print( aNestLevel, "(net %d %s)\n",
583  m_mapping->Translate( net->GetNet() ),
584  m_out->Quotew( net->GetNetname() ).c_str() );
585  }
586 
587  m_out->Print( 0, "\n" );
588 }
OUTPUTFORMATTER * m_out
output any Format()s to this, no ownership
std::string Quotew(const wxString &aWrapee)
Definition: richio.cpp:472
NETINFO_MAPPING * m_mapping
mapping for net codes, so only not empty net codes are stored with consecutive integers as net codes
NETINFO_ITEM handles the data for a net.
Definition: netinfo.h:65
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
int Translate(int aNetCode) const
Function Translate Translates net number according to the map prepared by Update() function.

References PCB_IO::m_mapping, PCB_IO::m_out, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), and NETINFO_MAPPING::Translate().

Referenced by PCB_IO::formatHeader(), and CLIPBOARD_IO::SaveSelection().

◆ formatSetup()

void PCB_IO::formatSetup ( BOARD aBoard,
int  aNestLevel = 0 
) const
protectedinherited

formats the board setup information

Definition at line 473 of file kicad_plugin.cpp.

474 {
475  // Setup
476  m_out->Print( aNestLevel, "(setup\n" );
477 
478  // Save the board physical stackup structure
480 
481  if( aBoard->GetDesignSettings().m_HasStackup )
482  stackup.FormatBoardStackup( m_out,aBoard, aNestLevel+1 );
483 
484  BOARD_DESIGN_SETTINGS& dsnSettings = aBoard->GetDesignSettings();
485 
486  if( dsnSettings.m_AuxOrigin != wxPoint( 0, 0 ) )
487  m_out->Print( aNestLevel+1, "(aux_axis_origin %s %s)\n",
488  FormatInternalUnits( dsnSettings.m_AuxOrigin.x ).c_str(),
489  FormatInternalUnits( dsnSettings.m_AuxOrigin.y ).c_str() );
490 
491  if( dsnSettings.m_GridOrigin != wxPoint( 0, 0 ) )
492  m_out->Print( aNestLevel+1, "(grid_origin %s %s)\n",
493  FormatInternalUnits( dsnSettings.m_GridOrigin.x ).c_str(),
494  FormatInternalUnits( dsnSettings.m_GridOrigin.y ).c_str() );
495 
496  aBoard->GetPlotOptions().Format( m_out, aNestLevel+1 );
497 
498  m_out->Print( aNestLevel, ")\n\n" );
499 }
void FormatBoardStackup(OUTPUTFORMATTER *aFormatter, BOARD *aBoard, int aNestLevel) const
Writes the stackup info on board file.
OUTPUTFORMATTER * m_out
output any Format()s to this, no ownership
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition: class_board.h:575
wxPoint m_GridOrigin
origin for grid offsets
this class manage the layers needed to make a physical board they are solder mask,...
void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControl=0) const
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:551
BOARD_STACKUP & GetStackupDescriptor()
bool m_HasStackup
Set to true if the board has a stackup management.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
wxPoint m_AuxOrigin
origin for plot exports
std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from internal units to a string appropriate for writing ...
Definition: base_units.cpp:560
BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.

References PCB_PLOT_PARAMS::Format(), BOARD_STACKUP::FormatBoardStackup(), FormatInternalUnits(), BOARD::GetDesignSettings(), BOARD::GetPlotOptions(), BOARD_DESIGN_SETTINGS::GetStackupDescriptor(), BOARD_DESIGN_SETTINGS::m_AuxOrigin, BOARD_DESIGN_SETTINGS::m_GridOrigin, BOARD_DESIGN_SETTINGS::m_HasStackup, PCB_IO::m_out, OUTPUTFORMATTER::Print(), wxPoint::x, and wxPoint::y.

Referenced by PCB_IO::formatHeader().

◆ GetEnumeratedFootprint()

const MODULE * PCB_IO::GetEnumeratedFootprint ( const wxString &  aLibraryPath,
const wxString &  aFootprintName,
const PROPERTIES aProperties = NULL 
)
overridevirtualinherited

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

Reimplemented from PLUGIN.

Definition at line 2045 of file kicad_plugin.cpp.

2048 {
2049  return getFootprint( aLibraryPath, aFootprintName, aProperties, false );
2050 }
const MODULE * getFootprint(const wxString &aLibraryPath, const wxString &aFootprintName, const PROPERTIES *aProperties, bool checkModified)

References PCB_IO::getFootprint().

◆ GetFileExtension()

const wxString GITHUB_PLUGIN::GetFileExtension ( ) const
overridevirtual

Function GetFileExtension returns the file extension for the PLUGIN.

Implements PLUGIN.

Definition at line 134 of file github_plugin.cpp.

135 {
136  return wxEmptyString;
137 }

◆ getFootprint()

const MODULE * PCB_IO::getFootprint ( const wxString &  aLibraryPath,
const wxString &  aFootprintName,
const PROPERTIES aProperties,
bool  checkModified 
)
protectedinherited

Definition at line 2016 of file kicad_plugin.cpp.

2020 {
2021  LOCALE_IO toggle; // toggles on, then off, the C locale.
2022 
2023  init( aProperties );
2024 
2025  try
2026  {
2027  validateCache( aLibraryPath, checkModified );
2028  }
2029  catch( const IO_ERROR& )
2030  {
2031  // do nothing with the error
2032  }
2033 
2034  const MODULE_MAP& mods = m_cache->GetModules();
2035 
2036  MODULE_CITER it = mods.find( aFootprintName );
2037 
2038  if( it == mods.end() )
2039  return nullptr;
2040 
2041  return it->second->GetModule();
2042 }
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
FP_CACHE * m_cache
Footprint library cache.
void init(const PROPERTIES *aProperties)
std::map< wxString, MODULE * > MODULE_MAP
Definition: eagle_parser.h:51
void validateCache(const wxString &aLibraryPath, bool checkModified=true)
MODULE_MAP::const_iterator MODULE_CITER
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
MODULE_MAP & GetModules()

References FP_CACHE::GetModules(), PCB_IO::init(), PCB_IO::m_cache, and PCB_IO::validateCache().

Referenced by PCB_IO::FootprintLoad(), and PCB_IO::GetEnumeratedFootprint().

◆ GetLibraryTimestamp()

long long GITHUB_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 459 of file github_plugin.cpp.

460 {
461  // This plugin currently relies on the nginx server for caching (see comments
462  // at top of file).
463  // Since only the nginx server holds the timestamp information, we must defeat
464  // all caching above the nginx server.
465  return wxDateTime::Now().GetValue().GetValue();
466 
467 #if 0
468  // If we have no cache, return a number which won't match any stored timestamps
469  if( !m_gh_cache || m_lib_path != aLibraryPath )
470  return wxDateTime::Now().GetValue().GetValue();
471 
472  long long hash = m_gh_cache->GetTimestamp();
473 
474  if( m_pretty_dir.size() )
476 
477  return hash;
478 #endif
479 }
long long GetLibraryTimestamp(const wxString &aLibraryPath) const override
Generate a timestamp representing all the files in the library (including the library directory).
wxString m_lib_path
from aLibraryPath, something like https://github.com/liftoff-sr/pretty_footprints
wxString m_pretty_dir
GH_CACHE * m_gh_cache

References PCB_IO::GetLibraryTimestamp(), m_gh_cache, m_lib_path, and m_pretty_dir.

◆ GetStringOutput()

std::string PCB_IO::GetStringOutput ( bool  doClear)
inlineinherited

Definition at line 176 of file pcbnew/kicad_plugin.h.

177  {
178  std::string ret = m_sf.GetString();
179  if( doClear )
180  m_sf.Clear();
181 
182  return ret;
183  }
const std::string & GetString()
Definition: richio.h:475
STRING_FORMATTER m_sf
void Clear()
Function Clear clears the buffer and empties the internal string.
Definition: richio.h:464

References STRING_FORMATTER::Clear(), STRING_FORMATTER::GetString(), and PCB_IO::m_sf.

Referenced by FOOTPRINT_EDIT_FRAME::Export_Module().

◆ init()

void GITHUB_PLUGIN::init ( const PROPERTIES aProperties)
protected

◆ IsFootprintLibWritable()

bool GITHUB_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 248 of file github_plugin.cpp.

249 {
250  if( m_pretty_dir.size() )
252  else
253  return false;
254 }
bool IsFootprintLibWritable(const wxString &aLibraryPath) override
Function IsFootprintLibWritable returns true iff the library at aLibraryPath is writable.
wxString m_pretty_dir

References PCB_IO::IsFootprintLibWritable(), and m_pretty_dir.

Referenced by FootprintDelete(), and FootprintSave().

◆ Load()

BOARD * PCB_IO::Load ( const wxString &  aFileName,
BOARD aAppendToMe,
const PROPERTIES aProperties = NULL 
)
overridevirtualinherited

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 from PLUGIN.

Definition at line 1922 of file kicad_plugin.cpp.

1923 {
1924  FILE_LINE_READER reader( aFileName );
1925 
1926  init( aProperties );
1927 
1928  m_parser->SetLineReader( &reader );
1929  m_parser->SetBoard( aAppendToMe );
1930 
1931  BOARD* board;
1932 
1933  try
1934  {
1935  board = dynamic_cast<BOARD*>( m_parser->Parse() );
1936  }
1937  catch( const FUTURE_FORMAT_ERROR& )
1938  {
1939  // Don't wrap a FUTURE_FORMAT_ERROR in another
1940  throw;
1941  }
1942  catch( const PARSE_ERROR& parse_error )
1943  {
1944  if( m_parser->IsTooRecent() )
1945  throw FUTURE_FORMAT_ERROR( parse_error, m_parser->GetRequiredVersion() );
1946  else
1947  throw;
1948  }
1949 
1950  if( !board )
1951  {
1952  // The parser loaded something that was valid, but wasn't a board.
1953  THROW_PARSE_ERROR( _( "this file does not contain a PCB" ),
1954  m_parser->CurSource(), m_parser->CurLine(),
1955  m_parser->CurLineNumber(), m_parser->CurOffset() );
1956  }
1957 
1958  // Give the filename to the board if it's new
1959  if( !aAppendToMe )
1960  board->SetFileName( aFileName );
1961 
1962  return board;
1963 }
void init(const PROPERTIES *aProperties)
FILE_LINE_READER is a LINE_READER that reads from an open file.
Definition: richio.h:180
wxString GetRequiredVersion()
Return a string representing the version of kicad required to open this file.
Definition: pcb_parser.cpp:208
void SetBoard(BOARD *aBoard)
Definition: pcb_parser.h:342
void SetFileName(const wxString &aFileName)
Definition: class_board.h:253
PCB_PARSER * m_parser
#define THROW_PARSE_ERROR(aProblem, aSource, aInputLine, aLineNumber, aByteIndex)
BOARD_ITEM * Parse()
Definition: pcb_parser.cpp:481
LINE_READER * SetLineReader(LINE_READER *aReader)
Function SetLineReader sets aLineReader into the parser, and returns the previous one,...
Definition: pcb_parser.h:335
bool IsTooRecent()
Return whether a version number, if any was parsed, was too recent.
Definition: pcb_parser.h:360
Struct PARSE_ERROR contains a filename or source description, a problem input line,...
Definition: ki_exception.h:123
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:180
#define _(s)
Definition: 3d_actions.cpp:33
Struct FUTURE_FORMAT_ERROR variant of PARSE_ERROR indicating that a syntax or related error was likel...
Definition: ki_exception.h:172

References _, PCB_PARSER::GetRequiredVersion(), PCB_IO::init(), PCB_PARSER::IsTooRecent(), PCB_IO::m_parser, PCB_PARSER::Parse(), PCB_PARSER::SetBoard(), BOARD::SetFileName(), PCB_PARSER::SetLineReader(), and THROW_PARSE_ERROR.

◆ Parse()

BOARD_ITEM * PCB_IO::Parse ( const wxString &  aClipboardSourceInput)
inherited

Definition at line 378 of file kicad_plugin.cpp.

379 {
380  std::string input = TO_UTF8( aClipboardSourceInput );
381 
382  STRING_LINE_READER reader( input, wxT( "clipboard" ) );
383 
384  m_parser->SetLineReader( &reader );
385 
386  try
387  {
388  return m_parser->Parse();
389  }
390  catch( const PARSE_ERROR& parse_error )
391  {
392  if( m_parser->IsTooRecent() )
393  throw FUTURE_FORMAT_ERROR( parse_error, m_parser->GetRequiredVersion() );
394  else
395  throw;
396  }
397 }
wxString GetRequiredVersion()
Return a string representing the version of kicad required to open this file.
Definition: pcb_parser.cpp:208
PCB_PARSER * m_parser
BOARD_ITEM * Parse()
Definition: pcb_parser.cpp:481
LINE_READER * SetLineReader(LINE_READER *aReader)
Function SetLineReader sets aLineReader into the parser, and returns the previous one,...
Definition: pcb_parser.h:335
bool IsTooRecent()
Return whether a version number, if any was parsed, was too recent.
Definition: pcb_parser.h:360
Struct PARSE_ERROR contains a filename or source description, a problem input line,...
Definition: ki_exception.h:123
#define TO_UTF8(wxstring)
Struct FUTURE_FORMAT_ERROR variant of PARSE_ERROR indicating that a syntax or related error was likel...
Definition: ki_exception.h:172
STRING_LINE_READER is a LINE_READER that reads from a multiline 8 bit wide std::string.
Definition: richio.h:254

References PCB_PARSER::GetRequiredVersion(), PCB_PARSER::IsTooRecent(), PCB_IO::m_parser, PCB_PARSER::Parse(), PCB_PARSER::SetLineReader(), and TO_UTF8.

Referenced by CLIPBOARD_IO::Parse(), and parse_module_kicad().

◆ PluginName()

const wxString GITHUB_PLUGIN::PluginName ( ) const
overridevirtual

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

Implements PLUGIN.

Definition at line 128 of file github_plugin.cpp.

129 {
130  return "Github";
131 }

◆ PrefetchLib()

void GITHUB_PLUGIN::PrefetchLib ( const wxString &  aLibraryPath,
const PROPERTIES aProperties = NULL 
)
overridevirtual

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 from PLUGIN.

Definition at line 176 of file github_plugin.cpp.

178 {
179  if( m_lib_path != aLibraryPath )
180  {
181  m_zip_image.clear();
182  }
183 
184  remoteGetZip( aLibraryPath );
185 }
std::string m_zip_image
byte image of the zip file in its entirety.
wxString m_lib_path
from aLibraryPath, something like https://github.com/liftoff-sr/pretty_footprints
void remoteGetZip(const wxString &aRepoURL)
Function remoteGetZip fetches a zip file image from a github repo synchronously.

References m_lib_path, m_zip_image, and remoteGetZip().

◆ remoteGetZip()

void GITHUB_PLUGIN::remoteGetZip ( const wxString &  aRepoURL)
protected

Function remoteGetZip fetches a zip file image from a github repo synchronously.

The byte image is received into the m_input_stream. If the image has already been stored, do nothing.

Definition at line 555 of file github_plugin.cpp.

556 {
557  std::string zip_url;
558 
559  if( !m_zip_image.empty() )
560  return;
561 
562  if( !repoURL_zipURL( aRepoURL, &zip_url ) )
563  {
564  wxString msg = wxString::Format( _( "Unable to parse URL:\n\"%s\"" ), GetChars( aRepoURL ) );
565  THROW_IO_ERROR( msg );
566  }
567 
568  wxLogDebug( wxT( "Attempting to download: " ) + zip_url );
569 
570  KICAD_CURL_EASY kcurl; // this can THROW_IO_ERROR
571 
572  kcurl.SetURL( zip_url.c_str() );
573  kcurl.SetUserAgent( "http://kicad-pcb.org" );
574  kcurl.SetHeader( "Accept", "application/zip" );
575  kcurl.SetFollowRedirects( true );
576 
577  try
578  {
579  kcurl.Perform();
580  m_zip_image = kcurl.GetBuffer();
581  }
582  catch( const IO_ERROR& ioe )
583  {
584  // https "GET" has failed, report this to API caller.
585  // Note: kcurl.Perform() does not return an error if the file to download is not found
586  static const char errorcmd[] = "http GET command failed"; // Do not translate this message
587 
588  UTF8 fmt( _( "%s\nCannot get/download Zip archive: \"%s\"\nfor library path: \"%s\".\nReason: \"%s\"" ) );
589 
590  std::string msg = StrPrintf( fmt.c_str(),
591  errorcmd,
592  zip_url.c_str(),
593  TO_UTF8( aRepoURL ),
594  TO_UTF8( ioe.What() )
595  );
596 
597  THROW_IO_ERROR( msg );
598  }
599 
600  // If the zip archive is not existing, the received data is "Not Found" or "404: Not Found",
601  // and no error is returned by kcurl.Perform().
602  if( ( m_zip_image.compare( 0, 9, "Not Found", 9 ) == 0 ) ||
603  ( m_zip_image.compare( 0, 14, "404: Not Found", 14 ) == 0 ) )
604  {
605  UTF8 fmt( _( "Cannot download library \"%s\".\nThe library does not exist on the server" ) );
606  std::string msg = StrPrintf( fmt.c_str(), TO_UTF8( aRepoURL ) );
607 
608  THROW_IO_ERROR( msg );
609  }
610 }
UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to...
Definition: utf8.h:73
bool SetUserAgent(const std::string &aAgent)
Function SetUserAgent sets the request user agent.
void Perform()
Function perform equivalent to curl_easy_perform.
bool SetFollowRedirects(bool aFollow)
Function SetFollowRedirects enables the following of HTTP(s) and other redirects, by default curl doe...
int StrPrintf(std::string *aResult, const char *aFormat,...)
Function StrPrintf is like sprintf() but the output is appended to a std::string instead of to a char...
Definition: richio.cpp:74
KICAD_CURL_EASY wrapper interface around the curl_easy API.
std::string m_zip_image
byte image of the zip file in its entirety.
const std::string & GetBuffer()
Function GetBuffer returns a const reference to the recevied data buffer.
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
#define THROW_IO_ERROR(msg)
bool SetURL(const std::string &aURL)
Function SetURL sets the request URL.
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:153
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
#define _(s)
Definition: 3d_actions.cpp:33
#define TO_UTF8(wxstring)
static bool repoURL_zipURL(const wxString &aRepoURL, std::string *aZipURL)
Function repoURL_zipURL translates a repo URL to a zipfile URL name as commonly seen on github....
void SetHeader(const std::string &aName, const std::string &aValue)
Function SetHeader sets an arbitrary header for the HTTP(s) request.
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76

References _, UTF8::c_str(), Format(), KICAD_CURL_EASY::GetBuffer(), GetChars(), m_zip_image, KICAD_CURL_EASY::Perform(), repoURL_zipURL(), KICAD_CURL_EASY::SetFollowRedirects(), KICAD_CURL_EASY::SetHeader(), KICAD_CURL_EASY::SetURL(), KICAD_CURL_EASY::SetUserAgent(), numEval::StrPrintf(), THROW_IO_ERROR, TO_UTF8, and IO_ERROR::What().

Referenced by cacheLib(), and PrefetchLib().

◆ repoURL_zipURL()

bool GITHUB_PLUGIN::repoURL_zipURL ( const wxString &  aRepoURL,
std::string *  aZipURL 
)
staticprotected

Function repoURL_zipURL translates a repo URL to a zipfile URL name as commonly seen on github.com.

Parameters
aRepoURLpoints to the base of the repo.
aZipURLis where to put the zip file URL.
Returns
bool - true if aRepoULR was parseable, else false

Definition at line 482 of file github_plugin.cpp.

483 {
484  // e.g. "https://github.com/liftoff-sr/pretty_footprints"
485  //D(printf("aRepoURL:%s\n", TO_UTF8( aRepoURL ) );)
486 
487  wxURI repo( aRepoURL );
488 
489  if( repo.HasServer() && repo.HasPath() )
490  {
491  // scheme might be "http" or if truly github.com then "https".
492  wxString zip_url;
493 
494  if( repo.GetServer() == "github.com" )
495  {
496  //codeload.github.com only supports https
497  zip_url = "https://";
498 #if 0 // A proper code path would be this one, but it is not the fastest.
499  zip_url += repo.GetServer();
500  zip_url += repo.GetPath(); // path comes with a leading '/'
501  zip_url += "/archive/master.zip";
502 #else
503  // Github issues a redirect for the "master.zip". i.e.
504  // "https://github.com/liftoff-sr/pretty_footprints/archive/master.zip"
505  // would be redirected to:
506  // "https://codeload.github.com/liftoff-sr/pretty_footprints/zip/master"
507 
508  // In order to bypass this redirect, saving time, we use the
509  // redirected URL on first attempt to save one HTTP GET hit.
510  zip_url += "codeload.github.com";
511  zip_url += repo.GetPath(); // path comes with a leading '/'
512  zip_url += "/zip/master";
513 #endif
514  }
515 
516  else
517  {
518  zip_url = repo.GetScheme();
519  zip_url += "://";
520 
521  // This is the generic code path for any server which can serve
522  // up zip files. The schemes tested include: http and https.
523 
524  // zip_url goal: "<scheme>://<server>[:<port>]/<path>"
525 
526  // Remember that <scheme>, <server>, <port> if present, and <path> all came
527  // from the lib_path in the fp-lib-table row.
528 
529  // This code path is used with the nginx proxy setup, but is useful
530  // beyond that.
531 
532  zip_url += repo.GetServer();
533 
534  if( repo.HasPort() )
535  {
536  zip_url += ':';
537  zip_url += repo.GetPort();
538  }
539 
540  zip_url += repo.GetPath(); // path comes with a leading '/'
541 
542  // Do not modify the path, we cannot anticipate the needs of all
543  // servers which are serving up zip files directly. URL modifications
544  // are more generally done in the server, rather than contaminating
545  // this code path with the needs of one particular inflexible server.
546  }
547 
548  *aZipURL = zip_url.utf8_str();
549  return true;
550  }
551  return false;
552 }

Referenced by remoteGetZip().

◆ Save()

void PCB_IO::Save ( const wxString &  aFileName,
BOARD aBoard,
const PROPERTIES aProperties = NULL 
)
overridevirtualinherited

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 from PLUGIN.

Reimplemented in CLIPBOARD_IO.

Definition at line 354 of file kicad_plugin.cpp.

355 {
356  LOCALE_IO toggle; // toggles on, then off, the C locale.
357 
358  init( aProperties );
359 
360  m_board = aBoard; // after init()
361 
362  // Prepare net mapping that assures that net codes saved in a file are consecutive integers
363  m_mapping->SetBoard( aBoard );
364 
365  FILE_OUTPUTFORMATTER formatter( aFileName );
366 
367  m_out = &formatter; // no ownership
368 
369  m_out->Print( 0, "(kicad_pcb (version %d) (host pcbnew %s)\n", SEXPR_BOARD_FILE_VERSION,
370  formatter.Quotew( GetBuildVersion() ).c_str() );
371 
372  Format( aBoard, 1 );
373 
374  m_out->Print( 0, ")\n" );
375 }
OUTPUTFORMATTER * m_out
output any Format()s to this, no ownership
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
void init(const PROPERTIES *aProperties)
#define SEXPR_BOARD_FILE_VERSION
Current s-expression file format version. 2 was the last legacy format version.
void SetBoard(const BOARD *aBoard)
Function SetBoard Sets a BOARD object that is used to prepare the net code map.
Definition: netinfo.h:281
wxString GetBuildVersion()
Get the full KiCad version string.
NETINFO_MAPPING * m_mapping
mapping for net codes, so only not empty net codes are stored with consecutive integers as net codes
BOARD * m_board
which BOARD, no ownership here
FILE_OUTPUTFORMATTER may be used for text file output.
Definition: richio.h:492
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
void Format(BOARD_ITEM *aItem, int aNestLevel=0) const
Function Format outputs aItem to aFormatter in s-expression format.

References PCB_IO::Format(), GetBuildVersion(), PCB_IO::init(), PCB_IO::m_board, PCB_IO::m_mapping, PCB_IO::m_out, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), NETINFO_MAPPING::SetBoard(), and SEXPR_BOARD_FILE_VERSION.

Referenced by KI_TEST::DumpBoardToFile().

◆ SetOutputFormatter()

void PCB_IO::SetOutputFormatter ( OUTPUTFORMATTER aFormatter)
inlineinherited

Definition at line 185 of file pcbnew/kicad_plugin.h.

185 { m_out = aFormatter; }
OUTPUTFORMATTER * m_out
output any Format()s to this, no ownership

References PCB_IO::m_out.

Referenced by FP_CACHE::Save().

◆ validateCache()

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

Definition at line 1975 of file kicad_plugin.cpp.

1976 {
1977  if( !m_cache || !m_cache->IsPath( aLibraryPath ) || ( checkModified && m_cache->IsModified() ) )
1978  {
1979  // a spectacular episode in memory management:
1980  delete m_cache;
1981  m_cache = new FP_CACHE( this, aLibraryPath );
1982  m_cache->Load();
1983  }
1984 }
friend class FP_CACHE
bool IsModified()
Function IsModified Return true if the cache is not up-to-date.
FP_CACHE * m_cache
Footprint library cache.
bool IsPath(const wxString &aPath) const
Function IsPath checks if aPath is the same as the current cache path.
void Load()

References PCB_IO::FP_CACHE, FP_CACHE::IsModified(), FP_CACHE::IsPath(), FP_CACHE::Load(), and PCB_IO::m_cache.

Referenced by PCB_IO::FootprintDelete(), PCB_IO::FootprintEnumerate(), PCB_IO::FootprintSave(), PCB_IO::getFootprint(), and PCB_IO::IsFootprintLibWritable().

Member Data Documentation

◆ m_board

BOARD* PCB_IO::m_board
protectedinherited

◆ m_cache

◆ m_ctl

int PCB_IO::m_ctl
protectedinherited

◆ m_error

wxString PCB_IO::m_error
protectedinherited

for throwing exceptions

Definition at line 191 of file pcbnew/kicad_plugin.h.

◆ m_filename

wxString PCB_IO::m_filename
protectedinherited

for saves only, name is in m_reader for loads

Definition at line 199 of file pcbnew/kicad_plugin.h.

◆ m_gh_cache

GH_CACHE* GITHUB_PLUGIN::m_gh_cache
protected

◆ m_lib_path

wxString GITHUB_PLUGIN::m_lib_path
protected

from aLibraryPath, something like https://github.com/liftoff-sr/pretty_footprints

Definition at line 228 of file github_plugin.h.

Referenced by cacheLib(), GetLibraryTimestamp(), and PrefetchLib().

◆ m_loading_format_version

int PCB_IO::m_loading_format_version
protectedinherited

which SEXPR_BOARD_FILE_VERSION should be Load()ed?

Definition at line 201 of file pcbnew/kicad_plugin.h.

Referenced by PCB_IO::init().

◆ m_mapping

NETINFO_MAPPING* PCB_IO::m_mapping
protectedinherited

mapping for net codes, so only not empty net codes are stored with consecutive integers as net codes

Definition at line 207 of file pcbnew/kicad_plugin.h.

Referenced by PCB_IO::format(), PCB_IO::formatGeneral(), PCB_IO::formatNetInformation(), CLIPBOARD_IO::Save(), PCB_IO::Save(), CLIPBOARD_IO::SaveSelection(), and PCB_IO::~PCB_IO().

◆ m_out

◆ m_parser

PCB_PARSER* PCB_IO::m_parser
protectedinherited

◆ m_pretty_dir

◆ m_props

const PROPERTIES* PCB_IO::m_props
protectedinherited

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

Definition at line 195 of file pcbnew/kicad_plugin.h.

Referenced by PCB_IO::init().

◆ m_reader

LINE_READER* PCB_IO::m_reader
protectedinherited

no ownership here.

Definition at line 198 of file pcbnew/kicad_plugin.h.

Referenced by PCB_IO::init().

◆ m_sf

STRING_FORMATTER PCB_IO::m_sf
protectedinherited

Definition at line 203 of file pcbnew/kicad_plugin.h.

Referenced by PCB_IO::GetStringOutput(), and PCB_IO::PCB_IO().

◆ m_zip_image

std::string GITHUB_PLUGIN::m_zip_image
protected

byte image of the zip file in its entirety.

Definition at line 229 of file github_plugin.h.

Referenced by cacheLib(), FootprintLoad(), PrefetchLib(), and remoteGetZip().


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