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 &aLibraryPath, 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 formatDefaults (const BOARD_DESIGN_SETTINGS &aSettings, int aNestLevel) const
 formats the defaults subsection of the board setup 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 116 of file github_plugin.cpp.

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

◆ ~GITHUB_PLUGIN()

GITHUB_PLUGIN::~GITHUB_PLUGIN ( )

Definition at line 123 of file github_plugin.cpp.

124 {
125  delete m_gh_cache;
126 }
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 367 of file github_plugin.cpp.

368 {
369  // This is edge triggered based on a change in 'aLibraryPath',
370  // usually it does nothing. When the edge fires, m_pretty_dir is set
371  // to either:
372  // 1) empty or
373  // 2) a verified and validated, writable, *.pretty directory.
374 
375  if( !m_gh_cache || m_lib_path != aLibraryPath )
376  {
377  delete m_gh_cache;
378  m_gh_cache = 0;
379  m_pretty_dir.clear();
380 
381  if( !m_lib_path.empty() )
382  {
383  // Library path wasn't empty before - it's been changed. Flush out the prefetch cache.
384  m_zip_image.clear();
385  }
386 
387  if( aProperties )
388  {
389  UTF8 pretty_dir;
390 
391  if( aProperties->Value( PRETTY_DIR, &pretty_dir ) )
392  {
393  wxString wx_pretty_dir = pretty_dir;
394 
395  wx_pretty_dir = LIB_TABLE::ExpandSubstitutions( wx_pretty_dir );
396 
397  wxFileName wx_pretty_fn = wx_pretty_dir;
398 
399  if( !wx_pretty_fn.IsOk() ||
400  !wx_pretty_fn.IsDirWritable() ||
401  wx_pretty_fn.GetExt() != "pretty"
402  )
403  {
404  wxString msg = wxString::Format(
405  _( "option \"%s\" for Github library \"%s\" must point to a writable directory ending with '.pretty'." ),
407  GetChars( aLibraryPath )
408  );
409 
410  THROW_IO_ERROR( msg );
411  }
412 
413  m_pretty_dir = wx_pretty_dir;
414  }
415  }
416 
417  // operator==( wxString, wxChar* ) does not exist, construct wxString once here.
418  const wxString kicad_mod( "kicad_mod" );
419 
420  //D(printf("%s: this:%p m_lib_path:'%s' aLibraryPath:'%s'\n", __func__, this, TO_UTF8( m_lib_path), TO_UTF8(aLibraryPath) );)
421  m_gh_cache = new GH_CACHE();
422 
423  // INIT_LOGGER( "/tmp", "test.log" );
424  remoteGetZip( aLibraryPath );
425  // UNINIT_LOGGER();
426 
427  m_lib_path = aLibraryPath;
428 
429  wxMemoryInputStream mis( &m_zip_image[0], m_zip_image.size() );
430 
431  // Recently the zip standard adopted UTF8 encoded filenames within the
432  // internal zip directory block. Please only use zip files that conform
433  // to that standard. Github seems to now, but may not have earlier.
434  wxZipInputStream zis( mis, wxConvUTF8 );
435 
436  wxZipEntry* entry;
437  wxString fp_name;
438 
439  while( ( entry = zis.GetNextEntry() ) != NULL )
440  {
441  wxFileName fn( entry->GetName() ); // chop long name into parts
442 
443  if( fn.GetExt() == kicad_mod )
444  {
445  fp_name = fn.GetName(); // omit extension & path
446 
447  m_gh_cache->insert( fp_name, entry );
448  }
449  else
450  delete entry;
451  }
452  }
453 }
Class UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion supp...
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:62
static const wxString ExpandSubstitutions(const wxString &aString)
Replaces any environment variable references with their values and is here to fully embellish the TAB...
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
#define THROW_IO_ERROR(msg)
wxString m_pretty_dir
#define _(s)
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:101
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
void remoteGetZip(const wxString &aRepoURL)
Function remoteGetZip fetches a zip file image from a github repo synchronously.
GH_CACHE * m_gh_cache
Class 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 _, LIB_TABLE::ExpandSubstitutions(), Format(), FROM_UTF8(), GetChars(), m_gh_cache, m_lib_path, m_pretty_dir, m_zip_image, 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 278 of file github_plugin.cpp.

280 {
281  // set m_pretty_dir to either empty or something in aProperties
282  cacheLib( aLibraryPath, aProperties );
283 
284  if( GITHUB_PLUGIN::IsFootprintLibWritable( aLibraryPath ) )
285  {
286  // Does the PCB_IO base class have this footprint?
287  // We cannot write to github.
288 
289  wxArrayString pretties;
290 
291  PCB_IO::FootprintEnumerate( pretties, m_pretty_dir, aProperties );
292 
293  if( pretties.Index( aFootprintName ) != wxNOT_FOUND )
294  {
295  PCB_IO::FootprintDelete( m_pretty_dir, aFootprintName, aProperties );
296  }
297  else
298  {
299  wxString msg = wxString::Format(
300  _( "Footprint\n\"%s\"\nis not in the writable portion of this Github library\n\"%s\"" ),
301  GetChars( aFootprintName ),
302  GetChars( aLibraryPath )
303  );
304 
305  THROW_IO_ERROR( msg );
306  }
307  }
308  else
309  {
310  // This typically will not happen if the caller first properly calls
311  // IsFootprintLibWritable() to determine if calling FootprintSave() is
312  // even legal, so I spend no time on internationalization here:
313 
314  string msg = StrPrintf( "Github library\n\"%s\"\nis only writable if you set option \"%s\" in Library Tables dialog.",
315  TO_UTF8( aLibraryPath ), PRETTY_DIR );
316 
317  THROW_IO_ERROR( msg );
318  }
319 }
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 FootprintEnumerate(wxArrayString &aFootprintNames, const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL) override
Return a list of footprint names contained within the library at aLibraryPath.
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
void cacheLib(const wxString &aLibraryPath, const PROPERTIES *aProperties)
#define THROW_IO_ERROR(msg)
wxString m_pretty_dir
#define _(s)
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:101
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
bool IsFootprintLibWritable(const wxString &aLibraryPath) override
Function IsFootprintLibWritable returns true iff the library at aLibraryPath is writable.
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,
const PROPERTIES aProperties = NULL 
)
overridevirtual

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

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
aPropertiesis an associative array that can be used to tell the plugin anything needed about how to perform with respect to aLibraryPath. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.
aFootprintNamesis the array of available footprint names inside a library.
Exceptions
IO_ERRORif the library cannot be found, or footprint cannot be loaded.

Reimplemented from PLUGIN.

Definition at line 141 of file github_plugin.cpp.

143 {
144  //D(printf("%s: this:%p aLibraryPath:\"%s\"\n", __func__, this, TO_UTF8(aLibraryPath) );)
145  cacheLib( aLibraryPath, aProperties );
146 
147  typedef std::set<wxString> MYSET;
148 
149  MYSET unique;
150 
151  if( m_pretty_dir.size() )
152  {
153  wxArrayString locals;
154 
156 
157  for( unsigned i=0; i<locals.GetCount(); ++i )
158  unique.insert( locals[i] );
159  }
160 
161  for( MODULE_ITER it = m_gh_cache->begin(); it!=m_gh_cache->end(); ++it )
162  {
163  unique.insert( it->first );
164  }
165 
166  for( MYSET::const_iterator it = unique.begin(); it != unique.end(); ++it )
167  {
168  aFootprintNames.Add( *it );
169  }
170 }
MODULE_MAP::iterator MODULE_ITER
void FootprintEnumerate(wxArrayString &aFootprintNames, const wxString &aLibraryPath, const PROPERTIES *aProperties=NULL) override
Return a list of footprint names contained within the library at aLibraryPath.
void cacheLib(const wxString &aLibraryPath, const PROPERTIES *aProperties)
wxString m_pretty_dir
size_t i
Definition: json11.cpp:597
GH_CACHE * m_gh_cache

References cacheLib(), PCB_IO::FootprintEnumerate(), i, 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 2103 of file kicad_plugin.cpp.

2105 {
2106  // Note: checking the cache sounds like a good idea, but won't catch files which differ
2107  // only in case.
2108  //
2109  // Since this goes out to the native filesystem, we get platform differences (ie: MSW's
2110  // case-insensitive filesystem) handled "for free".
2111  // Warning: footprint names frequently contain a point. So be careful when initializing
2112  // wxFileName, and use a CTOR with extension specified
2113  wxFileName footprintFile( aLibraryPath, aFootprintName, KiCadFootprintFileExtension );
2114 
2115  return footprintFile.Exists();
2116 }
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 322 of file github_plugin.cpp.

323 {
324  // set m_pretty_dir to either empty or something in aProperties
325  cacheLib( aLibraryPath, aProperties );
326 
327  if( m_pretty_dir.size() )
329 }
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 332 of file github_plugin.cpp.

333 {
334  // set m_pretty_dir to either empty or something in aProperties
335  cacheLib( aLibraryPath, aProperties );
336 
337  if( m_pretty_dir.size() )
338  return PCB_IO::FootprintLibDelete( m_pretty_dir, aProperties );
339 
340  return false;
341 }
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 344 of file github_plugin.cpp.

345 {
346  // inherit options supported by all PLUGINs.
347  PLUGIN::FootprintLibOptions( aListToAppendTo );
348 
349  (*aListToAppendTo)[ PRETTY_DIR ] = UTF8( _(
350  "Set this property to a directory where footprints are to be written as pretty "
351  "footprints when saving to this library. Anything saved will take precedence over "
352  "footprints by the same name in the github repo. These saved footprints can then "
353  "be sent to the library maintainer as updates. "
354  "<p>The directory <b>must</b> have a <b>.pretty</b> file extension because the "
355  "format of the save is pretty.</p>"
356  ));
357 
358  /*
359  (*aListToAppendTo)["cache_github_zip_in_this_dir"] = UTF8( _(
360  "Set this property to a directory where the github *.zip file will be cached. "
361  "This should speed up subsequent visits to this library."
362  ));
363  */
364 }
Class UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion supp...
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)
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 185 of file github_plugin.cpp.

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

References cacheLib(), PCB_IO::FootprintLoad(), m_gh_cache, PCB_IO::m_parser, m_pretty_dir, m_zip_image, 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 254 of file github_plugin.cpp.

256 {
257  // set m_pretty_dir to either empty or something in aProperties
258  cacheLib( aLibraryPath, aProperties );
259 
260  if( GITHUB_PLUGIN::IsFootprintLibWritable( aLibraryPath ) )
261  {
262  PCB_IO::FootprintSave( m_pretty_dir, aFootprint, aProperties );
263  }
264  else
265  {
266  // This typically will not happen if the caller first properly calls
267  // IsFootprintLibWritable() to determine if calling FootprintSave() is
268  // even legal, so I spend no time on internationalization here:
269 
270  string msg = StrPrintf( "Github library\n\"%s\"\nis only writable if you set option \"%s\" in Library Tables dialog.",
271  TO_UTF8( aLibraryPath ), PRETTY_DIR );
272 
273  THROW_IO_ERROR( msg );
274  }
275 }
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
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
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.
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 398 of file kicad_plugin.cpp.

399 {
400  LOCALE_IO toggle; // public API function, perform anything convenient for caller
401 
402  switch( aItem->Type() )
403  {
404  case PCB_T:
405  format( static_cast<BOARD*>( aItem ), aNestLevel );
406  break;
407 
408  case PCB_DIMENSION_T:
409  format( static_cast<DIMENSION*>( aItem ), aNestLevel );
410  break;
411 
412  case PCB_LINE_T:
413  format( static_cast<DRAWSEGMENT*>( aItem ), aNestLevel );
414  break;
415 
416  case PCB_MODULE_EDGE_T:
417  format( static_cast<EDGE_MODULE*>( aItem ), aNestLevel );
418  break;
419 
420  case PCB_TARGET_T:
421  format( static_cast<PCB_TARGET*>( aItem ), aNestLevel );
422  break;
423 
424  case PCB_MODULE_T:
425  format( static_cast<MODULE*>( aItem ), aNestLevel );
426  break;
427 
428  case PCB_PAD_T:
429  format( static_cast<D_PAD*>( aItem ), aNestLevel );
430  break;
431 
432  case PCB_TEXT_T:
433  format( static_cast<TEXTE_PCB*>( aItem ), aNestLevel );
434  break;
435 
436  case PCB_MODULE_TEXT_T:
437  format( static_cast<TEXTE_MODULE*>( aItem ), aNestLevel );
438  break;
439 
440  case PCB_TRACE_T:
441  case PCB_VIA_T:
442  format( static_cast<TRACK*>( aItem ), aNestLevel );
443  break;
444 
445  case PCB_ZONE_AREA_T:
446  format( static_cast<ZONE_CONTAINER*>( aItem ), aNestLevel );
447  break;
448 
449  default:
450  wxFAIL_MSG( wxT( "Cannot format item " ) + aItem->GetClass() );
451  }
452 }
Definition: typeinfo.h:85
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:175
class ZONE_CONTAINER, a zone area
Definition: typeinfo.h:100
class TEXTE_PCB, text on a layer
Definition: typeinfo.h:92
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:95
class MODULE, a footprint
Definition: typeinfo.h:89
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:98
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:99
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:96
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References PCB_IO::format(), EDA_ITEM::GetClass(), PCB_DIMENSION_T, PCB_LINE_T, PCB_MODULE_EDGE_T, PCB_MODULE_T, PCB_MODULE_TEXT_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 651 of file kicad_plugin.cpp.

652 {
653  m_out->Print( aNestLevel, "(layers\n" );
654 
655  // Save only the used copper layers from front to back.
656  LSET visible_layers = aBoard->GetVisibleLayers();
657 
658  for( LSEQ cu = aBoard->GetEnabledLayers().CuStack(); cu; ++cu )
659  {
660  PCB_LAYER_ID layer = *cu;
661 
662  m_out->Print( aNestLevel+1, "(%d %s %s", layer,
663  m_out->Quotew( aBoard->GetLayerName( layer ) ).c_str(),
664  LAYER::ShowType( aBoard->GetLayerType( layer ) ) );
665 
666  if( !visible_layers[layer] )
667  m_out->Print( 0, " hide" );
668 
669  m_out->Print( 0, ")\n" );
670  }
671 
672  // Save used non-copper layers in the order they are defined.
673  // desired sequence for non Cu BOARD layers.
674  static const PCB_LAYER_ID non_cu[] =
675  {
676  B_Adhes, // 32
677  F_Adhes,
678  B_Paste,
679  F_Paste,
680  B_SilkS,
681  F_SilkS,
682  B_Mask,
683  F_Mask,
684  Dwgs_User,
685  Cmts_User,
686  Eco1_User,
687  Eco2_User,
688  Edge_Cuts,
689  Margin,
690  B_CrtYd,
691  F_CrtYd,
692  B_Fab,
693  F_Fab
694  };
695 
696  for( LSEQ seq = aBoard->GetEnabledLayers().Seq( non_cu, arrayDim( non_cu ) ); seq; ++seq )
697  {
698  PCB_LAYER_ID layer = *seq;
699 
700  m_out->Print( aNestLevel+1, "(%d %s user", layer,
701  m_out->Quotew( aBoard->GetLayerName( layer ) ).c_str() );
702 
703  if( !visible_layers[layer] )
704  m_out->Print( 0, " hide" );
705 
706  m_out->Print( 0, ")\n" );
707  }
708 
709  m_out->Print( aNestLevel, ")\n\n" );
710 }
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:150
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Function GetLayerName returns the name of a layer given by aLayer.
LSET GetVisibleLayers() const
Function GetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSetting...
LSET GetEnabledLayers() const
Function GetEnabledLayers is a proxy function that calls the corresponding function in m_BoardSetting...
#define cu(a)
Definition: auxiliary.h:88
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:367
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:
Class LSET is a set of PCB_LAYER_IDs.
std::string Quotew(const wxString &aWrapee)
Definition: richio.cpp:472
Class 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:108
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, cu, 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(), BOARD::GetVisibleLayers(), PCB_IO::m_out, Margin, OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), LSET::Seq(), and LAYER::ShowType().

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

◆ formatDefaults()

void PCB_IO::formatDefaults ( const BOARD_DESIGN_SETTINGS aSettings,
int  aNestLevel 
) const
protectedinherited

formats the defaults subsection of the board setup

Definition at line 586 of file kicad_plugin.cpp.

587 {
588  m_out->Print( aNestLevel, "(defaults\n" );
589 
590  m_out->Print( aNestLevel+1, "(edge_clearance %s)\n",
591  FormatInternalUnits( aSettings.m_CopperEdgeClearance ).c_str() );
592 
593  m_out->Print( aNestLevel+1, "(edge_cuts_line_width %s)\n",
594  FormatInternalUnits( aSettings.m_LineThickness[ LAYER_CLASS_EDGES ] ).c_str() );
595 
596  m_out->Print( aNestLevel+1, "(courtyard_line_width %s)\n",
598 
599  m_out->Print( aNestLevel+1, "(copper_line_width %s)\n",
600  FormatInternalUnits( aSettings.m_LineThickness[ LAYER_CLASS_COPPER ] ).c_str() );
601  m_out->Print( aNestLevel+1, "(copper_text_dims (size %s %s) (thickness %s)%s%s)\n",
602  FormatInternalUnits( aSettings.m_TextSize[ LAYER_CLASS_COPPER ].x ).c_str(),
603  FormatInternalUnits( aSettings.m_TextSize[ LAYER_CLASS_COPPER ].y ).c_str(),
605  aSettings.m_TextItalic[ LAYER_CLASS_COPPER ] ? " italic" : "",
606  aSettings.m_TextUpright[ LAYER_CLASS_COPPER ] ? " keep_upright" : "" );
607 
608  m_out->Print( aNestLevel+1, "(silk_line_width %s)\n",
609  FormatInternalUnits( aSettings.m_LineThickness[ LAYER_CLASS_SILK ] ).c_str() );
610  m_out->Print( aNestLevel+1, "(silk_text_dims (size %s %s) (thickness %s)%s%s)\n",
611  FormatInternalUnits( aSettings.m_TextSize[ LAYER_CLASS_SILK ].x ).c_str(),
612  FormatInternalUnits( aSettings.m_TextSize[ LAYER_CLASS_SILK ].y ).c_str(),
613  FormatInternalUnits( aSettings.m_TextThickness[ LAYER_CLASS_SILK ] ).c_str(),
614  aSettings.m_TextItalic[ LAYER_CLASS_SILK ] ? " italic" : "",
615  aSettings.m_TextUpright[ LAYER_CLASS_SILK ] ? " keep_upright" : "" );
616 
617  m_out->Print( aNestLevel+1, "(other_layers_line_width %s)\n",
618  FormatInternalUnits( aSettings.m_LineThickness[ LAYER_CLASS_OTHERS ] ).c_str() );
619  m_out->Print( aNestLevel+1, "(other_layers_text_dims (size %s %s) (thickness %s)%s%s)\n",
620  FormatInternalUnits( aSettings.m_TextSize[ LAYER_CLASS_OTHERS ].x ).c_str(),
621  FormatInternalUnits( aSettings.m_TextSize[ LAYER_CLASS_OTHERS ].y ).c_str(),
623  aSettings.m_TextItalic[ LAYER_CLASS_OTHERS ] ? " italic" : "",
624  aSettings.m_TextUpright[ LAYER_CLASS_OTHERS ] ? " keep_upright" : "" );
625 
626  m_out->Print( aNestLevel, ")\n" );
627 }
OUTPUTFORMATTER * m_out
output any Format()s to this, no ownership
wxSize m_TextSize[LAYER_CLASS_COUNT]
int m_TextThickness[LAYER_CLASS_COUNT]
bool m_TextItalic[LAYER_CLASS_COUNT]
int m_LineThickness[LAYER_CLASS_COUNT]
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
bool m_TextUpright[LAYER_CLASS_COUNT]
std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from internal units to a string appropriate for writing ...
Definition: base_units.cpp:465

References FormatInternalUnits(), LAYER_CLASS_COPPER, LAYER_CLASS_COURTYARD, LAYER_CLASS_EDGES, LAYER_CLASS_OTHERS, LAYER_CLASS_SILK, BOARD_DESIGN_SETTINGS::m_CopperEdgeClearance, BOARD_DESIGN_SETTINGS::m_LineThickness, PCB_IO::m_out, BOARD_DESIGN_SETTINGS::m_TextItalic, BOARD_DESIGN_SETTINGS::m_TextSize, BOARD_DESIGN_SETTINGS::m_TextThickness, BOARD_DESIGN_SETTINGS::m_TextUpright, and OUTPUTFORMATTER::Print().

Referenced by PCB_IO::formatSetup().

◆ formatGeneral()

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

formats the General section of the file

Definition at line 630 of file kicad_plugin.cpp.

631 {
632  const BOARD_DESIGN_SETTINGS& dsnSettings = aBoard->GetDesignSettings();
633 
634  m_out->Print( 0, "\n" );
635  m_out->Print( aNestLevel, "(general\n" );
636  // Write Bounding box info
637  m_out->Print( aNestLevel+1, "(thickness %s)\n",
638  FormatInternalUnits( dsnSettings.GetBoardThickness() ).c_str() );
639 
640  m_out->Print( aNestLevel+1, "(drawings %u)\n", (unsigned)aBoard->Drawings().size() );
641  m_out->Print( aNestLevel + 1, "(tracks %u)\n", (unsigned)aBoard->Tracks().size() );
642  m_out->Print( aNestLevel + 1, "(modules %u)\n", (unsigned)aBoard->Modules().size() );
643  m_out->Print( aNestLevel+1, "(nets %d)\n", m_mapping->GetSize() );
644  m_out->Print( aNestLevel, ")\n\n" );
645 
646  aBoard->GetPageSettings().Format( m_out, aNestLevel, m_ctl );
647  aBoard->GetTitleBlock().Format( m_out, aNestLevel, m_ctl );
648 }
OUTPUTFORMATTER * m_out
output any Format()s to this, no ownership
const PAGE_INFO & GetPageSettings() const
Definition: class_board.h:555
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:540
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:377
MODULES & Modules()
Definition: class_board.h:236
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:198
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:561
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:245
TRACKS & Tracks()
Definition: class_board.h:227
std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from internal units to a string appropriate for writing ...
Definition: base_units.cpp:465
Class 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 740 of file kicad_plugin.cpp.

741 {
742  formatGeneral( aBoard, aNestLevel );
743  // Layers.
744  formatBoardLayers( aBoard, aNestLevel );
745  // Setup
746  formatSetup( aBoard, aNestLevel );
747  // Save net codes and names
748  formatNetInformation( aBoard, aNestLevel );
749 }
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 713 of file kicad_plugin.cpp.

714 {
715  const BOARD_DESIGN_SETTINGS& dsnSettings = aBoard->GetDesignSettings();
716  for( NETINFO_ITEM* net : *m_mapping )
717  {
718  m_out->Print( aNestLevel, "(net %d %s)\n",
719  m_mapping->Translate( net->GetNet() ),
720  m_out->Quotew( net->GetNetname() ).c_str() );
721  }
722 
723  m_out->Print( 0, "\n" );
724 
725  // Save the default net class first.
726  NETCLASS defaultNC = *dsnSettings.GetDefault();
727  filterNetClass( *aBoard, defaultNC ); // Remove empty nets (from a copy of a netclass)
728  defaultNC.Format( m_out, aNestLevel, m_ctl );
729 
730  // Save the rest of the net classes alphabetically.
731  for( const auto& it : dsnSettings.m_NetClasses )
732  {
733  NETCLASS netclass = *it.second;
734  filterNetClass( *aBoard, netclass ); // Remove empty nets (from a copy of a netclass)
735  netclass.Format( m_out, aNestLevel, m_ctl );
736  }
737 }
OUTPUTFORMATTER * m_out
output any Format()s to this, no ownership
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:540
Class NETCLASS handles a collection of nets and the parameters used to route or test these nets.
Definition: netclass.h:55
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
Class NETINFO_ITEM handles the data for a net.
Definition: netinfo.h:65
NETCLASSPTR GetDefault() const
Function GetDefault.
void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
Function Format outputs the net class to aFormatter in s-expression form.
Definition: netclass.cpp:253
void filterNetClass(const BOARD &aBoard, NETCLASS &aNetClass)
Removes empty nets (i.e. with node count equal zero) from net classes
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.
Class BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.

References filterNetClass(), NETCLASS::Format(), BOARD_DESIGN_SETTINGS::GetDefault(), BOARD::GetDesignSettings(), PCB_IO::m_ctl, PCB_IO::m_mapping, BOARD_DESIGN_SETTINGS::m_NetClasses, 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 468 of file kicad_plugin.cpp.

469 {
470  const BOARD_DESIGN_SETTINGS& dsnSettings = aBoard->GetDesignSettings();
471 
472  // Setup
473  m_out->Print( aNestLevel, "(setup\n" );
474 
475  // Save current default track width, for compatibility with older Pcbnew version;
476  m_out->Print( aNestLevel+1, "(last_trace_width %s)\n",
477  FormatInternalUnits( dsnSettings.GetCurrentTrackWidth() ).c_str() );
478 
479  // Save custom track widths list (the first is not saved here: it's the netclass value)
480  for( unsigned ii = 1; ii < dsnSettings.m_TrackWidthList.size(); ii++ )
481  {
482  m_out->Print( aNestLevel+1, "(user_trace_width %s)\n",
483  FormatInternalUnits( dsnSettings.m_TrackWidthList[ii] ).c_str() );
484  }
485 
486  m_out->Print( aNestLevel+1, "(trace_clearance %s)\n",
487  FormatInternalUnits( dsnSettings.GetDefault()->GetClearance() ).c_str() );
488 
489  // ZONE_SETTINGS
490  m_out->Print( aNestLevel+1, "(zone_clearance %s)\n",
491  FormatInternalUnits( aBoard->GetZoneSettings().m_ZoneClearance ).c_str() );
492  m_out->Print( aNestLevel+1, "(zone_45_only %s)\n",
493  aBoard->GetZoneSettings().m_Zone_45_Only ? "yes" : "no" );
494 
495  m_out->Print( aNestLevel+1, "(trace_min %s)\n",
496  FormatInternalUnits( dsnSettings.m_TrackMinWidth ).c_str() );
497 
498  // Save current default via size, for compatibility with older Pcbnew version;
499  m_out->Print( aNestLevel+1, "(via_size %s)\n",
500  FormatInternalUnits( dsnSettings.GetDefault()->GetViaDiameter() ).c_str() );
501  m_out->Print( aNestLevel+1, "(via_drill %s)\n",
502  FormatInternalUnits( dsnSettings.GetDefault()->GetViaDrill() ).c_str() );
503  m_out->Print( aNestLevel+1, "(via_min_size %s)\n",
504  FormatInternalUnits( dsnSettings.m_ViasMinSize ).c_str() );
505  m_out->Print( aNestLevel+1, "(via_min_drill %s)\n",
506  FormatInternalUnits( dsnSettings.m_ViasMinDrill ).c_str() );
507 
508  // Save custom via dimensions list (the first is not saved here: it's the netclass value)
509  for( unsigned ii = 1; ii < dsnSettings.m_ViasDimensionsList.size(); ii++ )
510  m_out->Print( aNestLevel+1, "(user_via %s %s)\n",
511  FormatInternalUnits( dsnSettings.m_ViasDimensionsList[ii].m_Diameter ).c_str(),
512  FormatInternalUnits( dsnSettings.m_ViasDimensionsList[ii].m_Drill ).c_str() );
513 
514  // Save custom diff-pair dimensions (the first is not saved here: it's the netclass value)
515  for( unsigned ii = 1; ii < dsnSettings.m_DiffPairDimensionsList.size(); ii++ )
516  {
517  m_out->Print( aNestLevel+1, "(user_diff_pair %s %s %s)\n",
518  FormatInternalUnits( dsnSettings.m_DiffPairDimensionsList[ii].m_Width ).c_str(),
519  FormatInternalUnits( dsnSettings.m_DiffPairDimensionsList[ii].m_Gap ).c_str(),
520  FormatInternalUnits( dsnSettings.m_DiffPairDimensionsList[ii].m_ViaGap ).c_str() );
521  }
522 
523  // for old versions compatibility:
524  if( dsnSettings.m_BlindBuriedViaAllowed )
525  m_out->Print( aNestLevel+1, "(blind_buried_vias_allowed yes)\n" );
526 
527  m_out->Print( aNestLevel+1, "(uvia_size %s)\n",
528  FormatInternalUnits( dsnSettings.GetDefault()->GetuViaDiameter() ).c_str() );
529  m_out->Print( aNestLevel+1, "(uvia_drill %s)\n",
530  FormatInternalUnits( dsnSettings.GetDefault()->GetuViaDrill() ).c_str() );
531  m_out->Print( aNestLevel+1, "(uvias_allowed %s)\n",
532  ( dsnSettings.m_MicroViasAllowed ) ? "yes" : "no" );
533  m_out->Print( aNestLevel+1, "(uvia_min_size %s)\n",
534  FormatInternalUnits( dsnSettings.m_MicroViasMinSize ).c_str() );
535  m_out->Print( aNestLevel+1, "(uvia_min_drill %s)\n",
536  FormatInternalUnits( dsnSettings.m_MicroViasMinDrill ).c_str() );
537 
538  m_out->Print( aNestLevel+1, "(max_error %s)\n",
539  FormatInternalUnits( dsnSettings.m_MaxError ).c_str() );
540 
541  // Store this option only if it is not the legacy option:
542  if( dsnSettings.m_ZoneUseNoOutlineInFill )
543  m_out->Print( aNestLevel+1, "(filled_areas_thickness no)\n" );
544 
545  formatDefaults( dsnSettings, aNestLevel+1 );
546 
547  m_out->Print( aNestLevel+1, "(pad_size %s %s)\n",
548  FormatInternalUnits( dsnSettings.m_Pad_Master.GetSize().x ).c_str(),
549  FormatInternalUnits( dsnSettings.m_Pad_Master.GetSize().y ).c_str() );
550  m_out->Print( aNestLevel+1, "(pad_drill %s)\n",
551  FormatInternalUnits( dsnSettings.m_Pad_Master.GetDrillSize().x ).c_str() );
552 
553  m_out->Print( aNestLevel+1, "(pad_to_mask_clearance %s)\n",
554  FormatInternalUnits( dsnSettings.m_SolderMaskMargin ).c_str() );
555 
556  if( dsnSettings.m_SolderMaskMinWidth )
557  m_out->Print( aNestLevel+1, "(solder_mask_min_width %s)\n",
558  FormatInternalUnits( dsnSettings.m_SolderMaskMinWidth ).c_str() );
559 
560  if( dsnSettings.m_SolderPasteMargin != 0 )
561  m_out->Print( aNestLevel+1, "(pad_to_paste_clearance %s)\n",
562  FormatInternalUnits( dsnSettings.m_SolderPasteMargin ).c_str() );
563 
564  if( dsnSettings.m_SolderPasteMarginRatio != 0 )
565  m_out->Print( aNestLevel+1, "(pad_to_paste_clearance_ratio %s)\n",
566  Double2Str( dsnSettings.m_SolderPasteMarginRatio ).c_str() );
567 
568  m_out->Print( aNestLevel+1, "(aux_axis_origin %s %s)\n",
569  FormatInternalUnits( aBoard->GetAuxOrigin().x ).c_str(),
570  FormatInternalUnits( aBoard->GetAuxOrigin().y ).c_str() );
571 
572  if( aBoard->GetGridOrigin().x || aBoard->GetGridOrigin().y )
573  m_out->Print( aNestLevel+1, "(grid_origin %s %s)\n",
574  FormatInternalUnits( aBoard->GetGridOrigin().x ).c_str(),
575  FormatInternalUnits( aBoard->GetGridOrigin().y ).c_str() );
576 
577  m_out->Print( aNestLevel+1, "(visible_elements %X)\n",
578  dsnSettings.GetVisibleElements() );
579 
580  aBoard->GetPlotOptions().Format( m_out, aNestLevel+1 );
581 
582  m_out->Print( aNestLevel, ")\n\n" );
583 }
int m_SolderMaskMargin
Solder mask margin.
OUTPUTFORMATTER * m_out
output any Format()s to this, no ownership
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition: class_board.h:558
int m_SolderPasteMargin
Solder paste margin absolute value.
int GetCurrentTrackWidth() const
Function GetCurrentTrackWidth.
std::vector< int > m_TrackWidthList
std::vector< DIFF_PAIR_DIMENSION > m_DiffPairDimensionsList
void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControl=0) const
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:540
std::string Double2Str(double aValue)
Helper function Double2Str to print a float number without using scientific notation and no trailing ...
Definition: base_units.cpp:63
int m_TrackMinWidth
track min value for width ((min copper size value
int m_ViasMinSize
vias (not micro vias) min diameter
int m_ViasMinDrill
vias (not micro vias) min drill diameter
int m_ZoneClearance
Clearance value.
Definition: zone_settings.h:64
bool m_BlindBuriedViaAllowed
true to allow blind/buried vias
const wxPoint & GetAuxOrigin() const
Definition: class_board.h:363
int m_MicroViasMinSize
micro vias (not vias) min diameter
const wxPoint & GetGridOrigin() const
Definition: class_board.h:370
int GetVisibleElements() const
Function GetVisibleElements returns a bit-mask of all the element categories that are visible.
NETCLASSPTR GetDefault() const
Function GetDefault.
bool m_ZoneUseNoOutlineInFill
Option to handle filled polygons in zones: the "legacy" option is using thick outlines around filled ...
const wxSize & GetDrillSize() const
Definition: class_pad.h:290
D_PAD m_Pad_Master
A dummy pad to store all default parameters.
const ZONE_SETTINGS & GetZoneSettings() const
Definition: class_board.h:564
std::vector< VIA_DIMENSION > m_ViasDimensionsList
void formatDefaults(const BOARD_DESIGN_SETTINGS &aSettings, int aNestLevel) const
formats the defaults subsection of the board setup
bool m_MicroViasAllowed
true to allow micro vias
int m_MicroViasMinDrill
micro vias (not vias) min drill diameter
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
double m_SolderPasteMarginRatio
Solder pask margin ratio value of pad size The final margin is the sum of these 2 values.
const wxSize & GetSize() const
Definition: class_pad.h:284
std::string FormatInternalUnits(int aValue)
Function FormatInternalUnits converts aValue from internal units to a string appropriate for writing ...
Definition: base_units.cpp:465
int m_SolderMaskMinWidth
Solder mask min width.
Class BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.

References Double2Str(), PCB_PLOT_PARAMS::Format(), PCB_IO::formatDefaults(), FormatInternalUnits(), BOARD::GetAuxOrigin(), BOARD_DESIGN_SETTINGS::GetCurrentTrackWidth(), BOARD_DESIGN_SETTINGS::GetDefault(), BOARD::GetDesignSettings(), D_PAD::GetDrillSize(), BOARD::GetGridOrigin(), BOARD::GetPlotOptions(), D_PAD::GetSize(), BOARD_DESIGN_SETTINGS::GetVisibleElements(), BOARD::GetZoneSettings(), BOARD_DESIGN_SETTINGS::m_BlindBuriedViaAllowed, BOARD_DESIGN_SETTINGS::m_DiffPairDimensionsList, BOARD_DESIGN_SETTINGS::m_MaxError, BOARD_DESIGN_SETTINGS::m_MicroViasAllowed, BOARD_DESIGN_SETTINGS::m_MicroViasMinDrill, BOARD_DESIGN_SETTINGS::m_MicroViasMinSize, PCB_IO::m_out, BOARD_DESIGN_SETTINGS::m_Pad_Master, BOARD_DESIGN_SETTINGS::m_SolderMaskMargin, BOARD_DESIGN_SETTINGS::m_SolderMaskMinWidth, BOARD_DESIGN_SETTINGS::m_SolderPasteMargin, BOARD_DESIGN_SETTINGS::m_SolderPasteMarginRatio, BOARD_DESIGN_SETTINGS::m_TrackMinWidth, BOARD_DESIGN_SETTINGS::m_TrackWidthList, BOARD_DESIGN_SETTINGS::m_ViasDimensionsList, BOARD_DESIGN_SETTINGS::m_ViasMinDrill, BOARD_DESIGN_SETTINGS::m_ViasMinSize, ZONE_SETTINGS::m_Zone_45_Only, ZONE_SETTINGS::m_ZoneClearance, BOARD_DESIGN_SETTINGS::m_ZoneUseNoOutlineInFill, and OUTPUTFORMATTER::Print().

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 2095 of file kicad_plugin.cpp.

2098 {
2099  return getFootprint( aLibraryPath, aFootprintName, aProperties, false );
2100 }
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 135 of file github_plugin.cpp.

136 {
137  return wxEmptyString;
138 }

◆ getFootprint()

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

Definition at line 2066 of file kicad_plugin.cpp.

2070 {
2071  LOCALE_IO toggle; // toggles on, then off, the C locale.
2072 
2073  init( aProperties );
2074 
2075  try
2076  {
2077  validateCache( aLibraryPath, checkModified );
2078  }
2079  catch( const IO_ERROR& )
2080  {
2081  // do nothing with the error
2082  }
2083 
2084  const MODULE_MAP& mods = m_cache->GetModules();
2085 
2086  MODULE_CITER it = mods.find( aFootprintName );
2087 
2088  if( it == mods.end() )
2089  return nullptr;
2090 
2091  return it->second->GetModule();
2092 }
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:175
FP_CACHE * m_cache
Footprint library cache.
void init(const PROPERTIES *aProperties)
void validateCache(const wxString &aLibraryPath, bool checkModified=true)
std::map< wxString, MODULE * > MODULE_MAP
Definition: eagle_plugin.h:36
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 456 of file github_plugin.cpp.

457 {
458  // This plugin currently relies on the nginx server for caching (see comments
459  // at top of file).
460  // Since only the nginx server holds the timestamp information, we must defeat
461  // all caching above the nginx server.
462  return wxDateTime::Now().GetValue().GetValue();
463 
464 #if 0
465  // If we have no cache, return a number which won't match any stored timestamps
466  if( !m_gh_cache || m_lib_path != aLibraryPath )
467  return wxDateTime::Now().GetValue().GetValue();
468 
469  long long hash = m_gh_cache->GetTimestamp();
470 
471  if( m_pretty_dir.size() )
473 
474  return hash;
475 #endif
476 }
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 166 of file pcbnew/kicad_plugin.h.

167  {
168  std::string ret = m_sf.GetString();
169  if( doClear )
170  m_sf.Clear();
171 
172  return ret;
173  }
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 245 of file github_plugin.cpp.

246 {
247  if( m_pretty_dir.size() )
249  else
250  return false;
251 }
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 1966 of file kicad_plugin.cpp.

1967 {
1968  FILE_LINE_READER reader( aFileName );
1969 
1970  init( aProperties );
1971 
1972  m_parser->SetLineReader( &reader );
1973  m_parser->SetBoard( aAppendToMe );
1974 
1975  BOARD* board;
1976 
1977  try
1978  {
1979  board = dynamic_cast<BOARD*>( m_parser->Parse() );
1980  }
1981  catch( const FUTURE_FORMAT_ERROR& )
1982  {
1983  // Don't wrap a FUTURE_FORMAT_ERROR in another
1984  throw;
1985  }
1986  catch( const PARSE_ERROR& parse_error )
1987  {
1988  if( m_parser->IsTooRecent() )
1989  throw FUTURE_FORMAT_ERROR( parse_error, m_parser->GetRequiredVersion() );
1990  else
1991  throw;
1992  }
1993 
1994  if( !board )
1995  {
1996  // The parser loaded something that was valid, but wasn't a board.
1997  THROW_PARSE_ERROR( _( "this file does not contain a PCB" ),
1998  m_parser->CurSource(), m_parser->CurLine(),
1999  m_parser->CurLineNumber(), m_parser->CurOffset() );
2000  }
2001 
2002  // Give the filename to the board if it's new
2003  if( !aAppendToMe )
2004  board->SetFileName( aFileName );
2005 
2006  return board;
2007 }
void init(const PROPERTIES *aProperties)
Class 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:184
void SetBoard(BOARD *aBoard)
Definition: pcb_parser.h:328
void SetFileName(const wxString &aFileName)
Definition: class_board.h:223
PCB_PARSER * m_parser
#define THROW_PARSE_ERROR(aProblem, aSource, aInputLine, aLineNumber, aByteIndex)
BOARD_ITEM * Parse()
Definition: pcb_parser.cpp:444
#define _(s)
LINE_READER * SetLineReader(LINE_READER *aReader)
Function SetLineReader sets aLineReader into the parser, and returns the previous one,...
Definition: pcb_parser.h:321
bool IsTooRecent()
Return whether a version number, if any was parsed, was too recent.
Definition: pcb_parser.h:346
Struct PARSE_ERROR contains a filename or source description, a problem input line,...
Definition: ki_exception.h:123
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:161
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 376 of file kicad_plugin.cpp.

377 {
378  std::string input = TO_UTF8( aClipboardSourceInput );
379 
380  STRING_LINE_READER reader( input, wxT( "clipboard" ) );
381 
382  m_parser->SetLineReader( &reader );
383 
384  try
385  {
386  return m_parser->Parse();
387  }
388  catch( const PARSE_ERROR& parse_error )
389  {
390  if( m_parser->IsTooRecent() )
391  throw FUTURE_FORMAT_ERROR( parse_error, m_parser->GetRequiredVersion() );
392  else
393  throw;
394  }
395 }
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
wxString GetRequiredVersion()
Return a string representing the version of kicad required to open this file.
Definition: pcb_parser.cpp:184
PCB_PARSER * m_parser
BOARD_ITEM * Parse()
Definition: pcb_parser.cpp:444
LINE_READER * SetLineReader(LINE_READER *aReader)
Function SetLineReader sets aLineReader into the parser, and returns the previous one,...
Definition: pcb_parser.h:321
bool IsTooRecent()
Return whether a version number, if any was parsed, was too recent.
Definition: pcb_parser.h:346
Struct PARSE_ERROR contains a filename or source description, a problem input line,...
Definition: ki_exception.h:123
Struct FUTURE_FORMAT_ERROR variant of PARSE_ERROR indicating that a syntax or related error was likel...
Definition: ki_exception.h:172
Class 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 129 of file github_plugin.cpp.

130 {
131  return "Github";
132 }

◆ 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 173 of file github_plugin.cpp.

175 {
176  if( m_lib_path != aLibraryPath )
177  {
178  m_zip_image.clear();
179  }
180 
181  remoteGetZip( aLibraryPath );
182 }
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 552 of file github_plugin.cpp.

553 {
554  std::string zip_url;
555 
556  if( !m_zip_image.empty() )
557  return;
558 
559  if( !repoURL_zipURL( aRepoURL, &zip_url ) )
560  {
561  wxString msg = wxString::Format( _( "Unable to parse URL:\n\"%s\"" ), GetChars( aRepoURL ) );
562  THROW_IO_ERROR( msg );
563  }
564 
565  wxLogDebug( wxT( "Attempting to download: " ) + zip_url );
566 
567  KICAD_CURL_EASY kcurl; // this can THROW_IO_ERROR
568 
569  kcurl.SetURL( zip_url.c_str() );
570  kcurl.SetUserAgent( "http://kicad-pcb.org" );
571  kcurl.SetHeader( "Accept", "application/zip" );
572  kcurl.SetFollowRedirects( true );
573 
574  try
575  {
576  kcurl.Perform();
577  m_zip_image = kcurl.GetBuffer();
578  }
579  catch( const IO_ERROR& ioe )
580  {
581  // https "GET" has failed, report this to API caller.
582  // Note: kcurl.Perform() does not return an error if the file to download is not found
583  static const char errorcmd[] = "http GET command failed"; // Do not translate this message
584 
585  UTF8 fmt( _( "%s\nCannot get/download Zip archive: \"%s\"\nfor library path: \"%s\".\nReason: \"%s\"" ) );
586 
587  std::string msg = StrPrintf( fmt.c_str(),
588  errorcmd,
589  zip_url.c_str(),
590  TO_UTF8( aRepoURL ),
591  TO_UTF8( ioe.What() )
592  );
593 
594  THROW_IO_ERROR( msg );
595  }
596 
597  // If the zip archive is not existing, the received data is "Not Found" or "404: Not Found",
598  // and no error is returned by kcurl.Perform().
599  if( ( m_zip_image.compare( 0, 9, "Not Found", 9 ) == 0 ) ||
600  ( m_zip_image.compare( 0, 14, "404: Not Found", 14 ) == 0 ) )
601  {
602  UTF8 fmt( _( "Cannot download library \"%s\".\nThe library does not exist on the server" ) );
603  std::string msg = StrPrintf( fmt.c_str(), TO_UTF8( aRepoURL ) );
604 
605  THROW_IO_ERROR( msg );
606  }
607 }
Class UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion supp...
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
Class KICAD_CURL_EASY wrapper interface around the curl_easy API.
std::string m_zip_image
byte image of the zip file in its entirety.
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
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)
#define _(s)
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:101
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
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 479 of file github_plugin.cpp.

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

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 352 of file kicad_plugin.cpp.

353 {
354  LOCALE_IO toggle; // toggles on, then off, the C locale.
355 
356  init( aProperties );
357 
358  m_board = aBoard; // after init()
359 
360  // Prepare net mapping that assures that net codes saved in a file are consecutive integers
361  m_mapping->SetBoard( aBoard );
362 
363  FILE_OUTPUTFORMATTER formatter( aFileName );
364 
365  m_out = &formatter; // no ownership
366 
367  m_out->Print( 0, "(kicad_pcb (version %d) (host pcbnew %s)\n", SEXPR_BOARD_FILE_VERSION,
368  formatter.Quotew( GetBuildVersion() ).c_str() );
369 
370  Format( aBoard, 1 );
371 
372  m_out->Print( 0, ")\n" );
373 }
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:175
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:283
wxString GetBuildVersion()
Function GetBuildVersion Return the build 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
Class 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.

◆ SetOutputFormatter()

void PCB_IO::SetOutputFormatter ( OUTPUTFORMATTER aFormatter)
inlineinherited

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

175 { 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 2019 of file kicad_plugin.cpp.

2020 {
2021  if( !m_cache || !m_cache->IsPath( aLibraryPath ) || ( checkModified && m_cache->IsModified() ) )
2022  {
2023  // a spectacular episode in memory management:
2024  delete m_cache;
2025  m_cache = new FP_CACHE( this, aLibraryPath );
2026  m_cache->Load();
2027  }
2028 }
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

◆ m_cache

◆ m_ctl

◆ m_error

wxString PCB_IO::m_error
protectedinherited

for throwing exceptions

Definition at line 181 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 189 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 191 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 197 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 185 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 188 of file pcbnew/kicad_plugin.h.

Referenced by PCB_IO::init().

◆ m_sf

STRING_FORMATTER PCB_IO::m_sf
protectedinherited

Definition at line 193 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: