KiCad PCB EDA Suite
pcbnew.cpp File Reference

Pcbnew main program. More...

#include <pgm_base.h>
#include <kiface_i.h>
#include <kiface_ids.h>
#include <confirm.h>
#include <pcb_edit_frame.h>
#include <eda_dde.h>
#include <wx/file.h>
#include <wx/log.h>
#include <wx/snglinst.h>
#include <gestfich.h>
#include <pcbnew.h>
#include <pcbnew_settings.h>
#include <settings/settings_manager.h>
#include <board.h>
#include <class_draw_panel_gal.h>
#include <fp_lib_table.h>
#include <footprint_edit_frame.h>
#include <footprint_viewer_frame.h>
#include <footprint_wizard_frame.h>
#include <footprint_preview_panel.h>
#include <footprint_info_impl.h>
#include <dialogs/dialog_configure_paths.h>
#include <paths.h>
#include "invoke_pcb_dialog.h"
#include "dialog_global_fp_lib_table_config.h"
#include <wildcards_and_files_ext.h>

Go to the source code of this file.

Classes

struct  PCB::IFACE
 

Namespaces

 PCB
 

Functions

PCB::IFACE KIFACE_I PCB::kiface ("pcbnew", KIWAY::FACE_PCB)
 
 IFACE (const char *aName, KIWAY::FACE_T aType)
 
bool OnKifaceStart (PGM_BASE *aProgram, int aCtlBits) override
 
void OnKifaceEnd () override
 
wxWindow * CreateWindow (wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override
 
void * IfaceOrAddress (int aDataId) override
 Function IfaceOrAddress return a pointer to the requested object. More...
 
void SaveFileAs (const wxString &aProjectBasePath, const wxString &aSrcProjectName, const wxString &aNewProjectBasePath, const wxString &aNewProjectName, const wxString &aSrcFilePath, wxString &aErrors) override
 Function SaveFileAs Saving a file under a different name is delegated to the various KIFACEs because the project doesn't know the internal format of the various files (which may have paths in them that need updating). More...
 
KIFACE_IKiface ()
 Global KIFACE_I "get" accessor. More...
 
 MY_API (KIFACE *) KIFACE_GETTER(int *aKIFACEversion
 
void PythonPluginsReloadBase ()
 Helper function PythonPluginsReloadBase Reload Python plugins if they are newer than the already loaded, and load new plugins if any It calls the LoadPlugins(bundlepath) Python method see kicadplugins.i. More...
 

Variables

static PGM_BASEprocess
 
int aKiwayVersion
 
int PGM_BASEaProgram
 
return & kiface
 
FP_LIB_TABLE GFootprintTable
 The global footprint library table. More...
 
FOOTPRINT_LIST_IMPL GFootprintList
 The global footprint info table. More...
 

Detailed Description

Pcbnew main program.

Definition in file pcbnew.cpp.

Function Documentation

◆ CreateWindow()

wxWindow* kiface::CreateWindow ( wxWindow *  aParent,
int  aClassId,
KIWAY aKiway,
int  aCtlBits = 0 
)
override

Definition at line 411 of file pcbnew.cpp.

420  {
421  if( destFile.GetName() == aSrcProjectName )
422  destFile.SetName( aNewProjectName );
423 
424  KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
425  }
426  else if( ext == LegacyPcbFileExtension )
427  {
428  if( destFile.GetName() == aSrcProjectName )
429  destFile.SetName( aNewProjectName );
430 
431  KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
432  }
434  {
435  // Footprints are not project-specific. Keep their source names.
436  KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
437  }
438  else if( ext == ComponentFileExtension )
439  {
440  // JEY TODO
441  }
442  else if( ext == "rpt" )
443  {
444  // DRC must be the "gold standard". Since we can't gaurantee that there aren't
445  // any non-deterministic cases in the save-as algorithm, we don't want to certify
446  // the result with the source's DRC report. Therefore copy it under the old
447  // name.
448  KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
449  }
450  else if( destFile.GetName() == "fp-lib-table" )
451  {
452  try
453  {
454  FP_LIB_TABLE fpLibTable;
455  fpLibTable.Load( aSrcFilePath );
456 
457  for( unsigned i = 0; i < fpLibTable.GetCount(); i++ )
458  {
459  LIB_TABLE_ROW& row = fpLibTable.At( i );
460  wxString uri = row.GetFullURI();
461 
462  uri.Replace( "/" + aSrcProjectName + ".pretty", "/" + aNewProjectName + ".pretty" );
463 
464  row.SetFullURI( uri );
465  }
466 
467  fpLibTable.Save( destFile.GetFullPath() );
468  }
469  catch( ... )
470  {
471  wxString msg;
472 
const std::string LegacyFootprintLibPathExtension
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
const std::string KiCadFootprintFileExtension
const std::string LegacyPcbFileExtension
unsigned GetCount() const
Get the number of rows contained in the table.
void KiCopyFile(const wxString &aSrcPath, const wxString &aDestPath, wxString &aErrors)
Definition: gestfich.cpp:363
const std::string ComponentFileExtension
const wxString GetFullURI(bool aSubstituted=false) const
Return the full location specifying URI for the LIB, either in original UI form or in environment var...
void Load(const wxString &aFileName)
Load the library table using the path defined by aFileName aFallBackTable.
void SetFullURI(const wxString &aFullURI)
Change the full URI for the library.
LIB_TABLE_ROW & At(unsigned aIndex)
Get the 'n'th LIB_TABLE_ROW object.
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.

References KiCopyFile().

◆ IFACE()

kiface::IFACE ( const char *  aName,
KIWAY::FACE_T  aType 
)

Definition at line 403 of file pcbnew.cpp.

403 {
404  wxFileName destFile( aSrcFilePath );
405  wxString destPath = destFile.GetPathWithSep();

◆ IfaceOrAddress()

void* kiface::IfaceOrAddress ( int  aDataId)
override

Function IfaceOrAddress return a pointer to the requested object.

The safest way to use this is to retrieve a pointer to a static instance of an interface, similar to how the KIFACE interface is exported. But if you know what you are doing use it to retrieve anything you want.

Parameters
aDataIdidentifies which object you want the address of.
Returns
void* - and must be cast into the know type.

Definition at line 482 of file pcbnew.cpp.

◆ Kiface()

KIFACE_I& Kiface ( )

Global KIFACE_I "get" accessor.

Definition at line 189 of file pcbnew.cpp.

189 { return kiface; }
return & kiface
Definition: pcbnew.cpp:197

References PCB::kiface().

Referenced by PCB::IFACE::CreateWindow().

◆ MY_API()

MY_API ( KIFACE )

◆ OnKifaceEnd()

void kiface::OnKifaceEnd ( )
override

Definition at line 47 of file mocks_eeschema.cpp.

51  {

◆ OnKifaceStart()

bool kiface::OnKifaceStart ( PGM_BASE aProgram,
int  aCtlBits 
)
override

Definition at line 40 of file common_mocks.cpp.

40 {
41  static PGM_TEST_FRAME program;
42  return program;
43 }
PGM_SINGLE_TOP program

References program.

◆ PythonPluginsReloadBase()

void PythonPluginsReloadBase ( )

Helper function PythonPluginsReloadBase Reload Python plugins if they are newer than the already loaded, and load new plugins if any It calls the LoadPlugins(bundlepath) Python method see kicadplugins.i.

Definition at line 303 of file pcbnew.cpp.

304 {
305 #if defined( KICAD_SCRIPTING )
306  // Reload plugin list: reload Python plugins if they are newer than the already loaded,
307  // and load new plugins
308  char cmd[1024];
309 
310  snprintf( cmd, sizeof( cmd ), "pcbnew.LoadPlugins(\"%s\", \"%s\")", TO_UTF8( PyScriptingPath() ),
311  TO_UTF8( PyScriptingPath( true ) ) );
312 
313  PyLOCK lock;
314 
315  // ReRun the Python method pcbnew.LoadPlugins (already called when starting Pcbnew)
316  int retv = PyRun_SimpleString( cmd );
317 
318  if( retv != 0 )
319  wxLogError( "Python error %d occurred running command:\n\n`%s`", retv, cmd );
320 #endif
321 }
wxString PyScriptingPath(bool aUserPath)
Find the Python scripting path.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96

References PyScriptingPath(), and TO_UTF8.

Referenced by PCB_EDIT_FRAME::PythonPluginsReload().

◆ SaveFileAs()

void kiface::SaveFileAs ( const wxString &  aProjectBasePath,
const wxString &  aSrcProjectName,
const wxString &  aNewProjectBasePath,
const wxString &  aNewProjectName,
const wxString &  aSrcFilePath,
wxString &  aErrors 
)
override

Function SaveFileAs Saving a file under a different name is delegated to the various KIFACEs because the project doesn't know the internal format of the various files (which may have paths in them that need updating).

Variable Documentation

◆ aKiwayVersion

int aKiwayVersion

Definition at line 194 of file pcbnew.cpp.

◆ aProgram

int PGM_BASE* aProgram
Initial value:
{
static PGM_BASE * process
Definition: pcbnew.cpp:186
int PGM_BASE * aProgram
Definition: pcbnew.cpp:195

Definition at line 195 of file pcbnew.cpp.

Referenced by PCB::IFACE::OnKifaceStart().

◆ GFootprintList

FOOTPRINT_LIST_IMPL GFootprintList

The global footprint info table.

This is performance-intensive to build so we keep a hash-stamped global version. Any deviation from the request vs. stored hash will result in it being rebuilt.

Definition at line 332 of file pcbnew.cpp.

Referenced by PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), FP_TREE_MODEL_ADAPTER::getFootprints(), PCB::IFACE::IfaceOrAddress(), FOOTPRINT_EDIT_FRAME::initLibraryTree(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::SelectFootprintFromLibTree(), and FOOTPRINT_EDIT_FRAME::SyncLibraryTree().

◆ GFootprintTable

FP_LIB_TABLE GFootprintTable

The global footprint library table.

!!!!!!!!!!!!!! This code is obsolete because of the merge into pcbnew, don't bother with it.

This is not dynamically allocated because in a multiple project environment we must keep its address constant (since it is the fallback table for multiple projects).

Definition at line 327 of file pcbnew.cpp.

Referenced by PCB::IFACE::IfaceOrAddress(), and PCB::IFACE::OnKifaceStart().

◆ kiface

return& kiface

Definition at line 197 of file pcbnew.cpp.

◆ process

PGM_BASE* process
static

Definition at line 186 of file pcbnew.cpp.