KiCad PCB EDA Suite
PCB::IFACE Struct Reference
Inheritance diagram for PCB::IFACE:
KIFACE_I KIFACE

Public Member Functions

 IFACE (const char *aName, KIWAY::FACE_T aType)
 
bool OnKifaceStart (PGM_BASE *aProgram, int aCtlBits) override
 Typically start_common() is called from here. More...
 
void OnKifaceEnd () override
 Called just once just before the DSO is to be unloaded. More...
 
wxWindow * CreateWindow (wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override
 Create a wxWindow for the current project. More...
 
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...
 
const wxString Name ()
 
APP_SETTINGS_BASEKifaceSettings () const
 
void InitSettings (APP_SETTINGS_BASE *aSettings)
 
int StartFlags () const
 Return whatever was passed as aCtlBits to OnKifaceStart(). More...
 
bool IsSingle () const
 Is this KIFACE_I running under single_top? More...
 
const wxString & GetHelpFileName () const
 Return just the basename portion of the current help file. More...
 
SEARCH_STACKKifaceSearch ()
 Only for DSO specific 'non-library' files. More...
 

Protected Member Functions

bool start_common (int aCtlBits)
 Common things to do for a top program module, during OnKifaceStart(). More...
 
void end_common ()
 Common things to do for a top program module, during OnKifaceEnd();. More...
 

Detailed Description

Definition at line 65 of file pcbnew.cpp.

Constructor & Destructor Documentation

◆ IFACE()

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

Definition at line 69 of file pcbnew.cpp.

69  :
70  KIFACE_I( aName, aType )
71  {}
KIFACE_I(const char *aKifaceName, KIWAY::FACE_T aId)
Definition: kiface_i.h:64

Member Function Documentation

◆ CreateWindow()

wxWindow* PCB::IFACE::CreateWindow ( wxWindow *  aParent,
int  aClassId,
KIWAY aKIWAY,
int  aCtlBits = 0 
)
inlineoverridevirtual

Create a wxWindow for the current project.

The caller must cast the return value into the known type.

Parameters
aParentmay be NULL or is otherwise the parent to connect under. If NULL then caller may want to connect the returned wxWindow into some hierarchy after this function returns.
aClassIdidentifies which wxFrame or wxDialog to retrieve, using a value known to the implementing KIFACE.
aKIWAYtells the window which KIWAY (and PROJECT) it is a participant in.
aCtlBitsconsists of bit flags from the set of KFCTL_* #defines above.
Returns
the window created and if not NULL, should be cast into the known type using and old school cast. dynamic_cast is problematic since it needs typeinfo probably not contained in the caller's link image.

Implements KIFACE_I.

Definition at line 77 of file pcbnew.cpp.

78  {
79  switch( aClassId )
80  {
81  case FRAME_PCB_EDITOR:
82  {
83  auto frame = new PCB_EDIT_FRAME( aKiway, aParent );
84 
85 #if defined( KICAD_SCRIPTING )
86  // give the scripting helpers access to our frame
87  ScriptingSetPcbEditFrame( frame );
88 #endif
89 
90  if( Kiface().IsSingle() )
91  {
92  // only run this under single_top, not under a project manager.
93  frame->CreateServer( KICAD_PCB_PORT_SERVICE_NUMBER );
94  }
95 
96  return frame;
97  }
98 
100  return new FOOTPRINT_EDIT_FRAME( aKiway, aParent,
102 
105  return new FOOTPRINT_VIEWER_FRAME( aKiway, aParent, FRAME_T( aClassId ) );
106 
108  return new FOOTPRINT_WIZARD_FRAME( aKiway, aParent, FRAME_T( aClassId ) );
109 
111  return dynamic_cast< wxWindow* >( FOOTPRINT_PREVIEW_PANEL::New( aKiway, aParent ) );
112 
114  {
115  DIALOG_CONFIGURE_PATHS dlg( aParent, aKiway->Prj().Get3DFilenameResolver() );
116 
117  // The dialog's constructor probably failed to set its Kiway because the
118  // dynamic_cast fails when aParent was allocated by a separate compiliation
119  // module. So set it directly.
120  dlg.SetKiway( &dlg, aKiway );
121 
122  // Use QuasiModal so that HTML help window will work
123  if( dlg.ShowQuasiModal() == wxID_OK )
124  aKiway->CommonSettingsChanged( true, false );
125 
126  // Dialog has completed; nothing to return.
127  return nullptr;
128  }
129 
131  InvokePcbLibTableEditor( aKiway, aParent );
132  // Dialog has completed; nothing to return.
133  return nullptr;
134 
135  default:
136  return nullptr;
137  }
138  }
FOOTPRINT_WIZARD_FRAME.
void SetKiway(wxWindow *aDest, KIWAY *aKiway)
It is only used for debugging, since "this" is not a wxWindow*.
#define KICAD_PCB_PORT_SERVICE_NUMBER
< Pcbnew listens on this port for commands from Eeschema
Definition: eda_dde.h:40
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:32
Component library viewer main window.
void ScriptingSetPcbEditFrame(PCB_EDIT_FRAME *aPcbEditFrame)
not specified: a GAL engine must be set by the client
void InvokePcbLibTableEditor(KIWAY *aKiway, wxWindow *aCaller)
Function InvokePcbLibTableEditor shows the modal DIALOG_FP_LIB_TABLE for purposes of editing the glob...
bool IsSingle() const
Is this KIFACE_I running under single_top?
Definition: kiface_i.h:104
static FOOTPRINT_PREVIEW_PANEL * New(KIWAY *aKiway, wxWindow *aParent)
The main frame for Pcbnew.
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
Definition: pcbnew.cpp:189

References KIWAY::CommonSettingsChanged(), DIALOG_CONFIGUREPATHS, DIALOG_PCB_LIBRARY_TABLE, FRAME_FOOTPRINT_EDITOR, FRAME_FOOTPRINT_PREVIEW, FRAME_FOOTPRINT_VIEWER, FRAME_FOOTPRINT_VIEWER_MODAL, FRAME_FOOTPRINT_WIZARD, FRAME_PCB_EDITOR, EDA_DRAW_PANEL_GAL::GAL_TYPE_UNKNOWN, InvokePcbLibTableEditor(), KIFACE_I::IsSingle(), KICAD_PCB_PORT_SERVICE_NUMBER, Kiface(), FOOTPRINT_PREVIEW_PANEL::New(), KIWAY::Prj(), ScriptingSetPcbEditFrame(), and KIWAY_HOLDER::SetKiway().

◆ end_common()

void KIFACE_I::end_common ( )
protectedinherited

Common things to do for a top program module, during OnKifaceEnd();.

Definition at line 94 of file kiface_i.cpp.

95 {
96  m_bm.End();
97 }
BIN_MOD m_bm
Definition: kiface_i.h:118
void End()
Definition: bin_mod.cpp:50

References BIN_MOD::End(), and KIFACE_I::m_bm.

Referenced by KIFACE_I::OnKifaceEnd(), PCBCALC::IFACE::OnKifaceEnd(), PGE::IFACE::OnKifaceEnd(), CV::IFACE::OnKifaceEnd(), GERBV::IFACE::OnKifaceEnd(), OnKifaceEnd(), and SCH::IFACE::OnKifaceEnd().

◆ GetHelpFileName()

const wxString& KIFACE_I::GetHelpFileName ( ) const
inlineinherited

Return just the basename portion of the current help file.

Definition at line 109 of file kiface_i.h.

109 { return m_bm.m_help_file; }
BIN_MOD m_bm
Definition: kiface_i.h:118
wxString m_help_file
Definition: bin_mod.h:58

References KIFACE_I::m_bm, and BIN_MOD::m_help_file.

Referenced by EDA_BASE_FRAME::help_name().

◆ IfaceOrAddress()

void* PCB::IFACE::IfaceOrAddress ( int  aDataId)
inlineoverridevirtual

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.

Implements KIFACE_I.

Definition at line 148 of file pcbnew.cpp.

149  {
150  switch( aDataId )
151  {
152  // Return a pointer to the global instance of the footprint list.
154  return (void*) &GFootprintList;
155 
156  // Return a new FP_LIB_TABLE with the global table installed as a fallback.
158  return (void*) new FP_LIB_TABLE( &GFootprintTable );
159 
160  // Return a pointer to the global instance of the global footprint table.
162  return (void*) &GFootprintTable;
163 
164  default:
165  return nullptr;
166  }
167  }
Return the global FP_LIB_TABLE.
Definition: kiface_ids.h:53
FP_LIB_TABLE GFootprintTable
The global footprint library table.
Definition: pcbnew.cpp:334
Return a new FP_LIB_TABLE with the global table installed as a fallback.
Definition: kiface_ids.h:46
FOOTPRINT_LIST_IMPL GFootprintList
The global footprint info table.
Definition: pcbnew.cpp:339
Return a pointer to the global instance of FOOTPRINT_LIST from pcbnew.
Definition: kiface_ids.h:39

References GFootprintList, GFootprintTable, KIFACE_FOOTPRINT_LIST, KIFACE_GLOBAL_FOOTPRINT_TABLE, and KIFACE_NEW_FOOTPRINT_TABLE.

◆ InitSettings()

void KIFACE_I::InitSettings ( APP_SETTINGS_BASE aSettings)
inlineinherited

Definition at line 94 of file kiface_i.h.

94 { m_bm.InitSettings( aSettings ); }
BIN_MOD m_bm
Definition: kiface_i.h:118
void InitSettings(APP_SETTINGS_BASE *aPtr)
Takes ownership of a new application settings object.
Definition: bin_mod.h:53

References BIN_MOD::InitSettings(), and KIFACE_I::m_bm.

Referenced by BMP2CMP::IFACE::CreateWindow(), PCBCALC::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), CV::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), OnKifaceStart(), and SCH::IFACE::OnKifaceStart().

◆ IsSingle()

◆ KifaceSearch()

SEARCH_STACK& KIFACE_I::KifaceSearch ( )
inlineinherited

Only for DSO specific 'non-library' files.

(The library search path is in the PROJECT class.)

Definition at line 113 of file kiface_i.h.

113 { return m_bm.m_search; }
BIN_MOD m_bm
Definition: kiface_i.h:118
SEARCH_STACK m_search
Definition: bin_mod.h:60

References KIFACE_I::m_bm, and BIN_MOD::m_search.

Referenced by CVPCB_MAINFRAME::buildEquivalenceList(), DS_DATA_MODEL::MakeFullFileName(), DS_DATA_MODEL::MakeShortFileName(), and EDA_BASE_FRAME::sys_search().

◆ KifaceSettings()

◆ Name()

const wxString KIFACE_I::Name ( )
inlineinherited

Definition at line 87 of file kiface_i.h.

88  {
89  return wxString::FromUTF8( m_bm.m_name );
90  }
BIN_MOD m_bm
Definition: kiface_i.h:118
const char * m_name
name of this binary module, static C string.
Definition: bin_mod.h:55

References KIFACE_I::m_bm, and BIN_MOD::m_name.

◆ OnKifaceEnd()

void IFACE::OnKifaceEnd ( )
overridevirtual

Called just once just before the DSO is to be unloaded.

It is called before static C++ destructors are called. A default implementation is supplied.

Reimplemented from KIFACE_I.

Definition at line 392 of file pcbnew.cpp.

393 {
394 #if defined( KICAD_SCRIPTING_WXPYTHON )
395  // Restore the thread state and tell Python to cleanup after itself.
396  // wxPython will do its own cleanup as part of that process.
397  // This should only be called if python was setup correctly.
398 
399  if( IsWxPythonLoaded() )
401 #endif
402 
403  end_common();
404 }
void pcbnewFinishPythonScripting()
void end_common()
Common things to do for a top program module, during OnKifaceEnd();.
Definition: kiface_i.cpp:94
bool IsWxPythonLoaded()

References KIFACE_I::end_common(), IsWxPythonLoaded(), and pcbnewFinishPythonScripting().

◆ OnKifaceStart()

bool IFACE::OnKifaceStart ( PGM_BASE aProgram,
int  aCtlBits 
)
overridevirtual

Typically start_common() is called from here.

Implements KIFACE_I.

Definition at line 343 of file pcbnew.cpp.

344 {
345  // This is process-level-initialization, not project-level-initialization of the DSO.
346  // Do nothing in here pertinent to a project!
349 
350  start_common( aCtlBits );
351 
352  wxFileName fn = FP_LIB_TABLE::GetGlobalTableFileName();
353 
354  if( !fn.FileExists() )
355  {
357 
358  fpDialog.ShowModal();
359  }
360  else
361  {
362  try
363  {
364  // The global table is not related to a specific project. All projects
365  // will use the same global table. So the KIFACE::OnKifaceStart() contract
366  // of avoiding anything project specific is not violated here.
368  return false;
369  }
370  catch( const IO_ERROR& ioe )
371  {
372  // if we are here, a incorrect global footprint library table was found.
373  // Incorrect global symbol library table is not a fatal error:
374  // the user just has to edit the (partially) loaded table.
375  wxString msg = _(
376  "An error occurred attempting to load the global footprint library table.\n"
377  "Please edit this global footprint library table in Preferences menu."
378  );
379 
380  DisplayErrorMessage( NULL, msg, ioe.What() );
381  }
382  }
383 
384 #if defined( KICAD_SCRIPTING )
385  scriptingSetup();
386 #endif
387 
388  return true;
389 }
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:166
bool start_common(int aCtlBits)
Common things to do for a top program module, during OnKifaceStart().
Definition: kiface_i.cpp:84
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:265
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:92
FP_LIB_TABLE GFootprintTable
The global footprint library table.
Definition: pcbnew.cpp:334
#define NULL
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
static bool LoadGlobalTable(FP_LIB_TABLE &aTable)
Load the global footprint library table into aTable.
JSON_SETTINGS * RegisterSettings(JSON_SETTINGS *aSettings, bool aLoadNow=true)
Takes ownership of the pointer passed in.
#define _(s)
Definition: 3d_actions.cpp:33
void InitSettings(APP_SETTINGS_BASE *aSettings)
Definition: kiface_i.h:94
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
static wxString GetGlobalTableFileName()
int PGM_BASE * aProgram
Definition: pcbnew.cpp:195

References _, aProgram, DisplayErrorMessage(), FP_LIB_TABLE::GetGlobalTableFileName(), PGM_BASE::GetSettingsManager(), GFootprintTable, KIFACE_I::InitSettings(), KIFACE_I::KifaceSettings(), FP_LIB_TABLE::LoadGlobalTable(), NULL, SETTINGS_MANAGER::RegisterSettings(), KIFACE_I::start_common(), and IO_ERROR::What().

◆ SaveFileAs()

void IFACE::SaveFileAs ( const wxString &  aProjectBasePath,
const wxString &  aSrcProjectName,
const wxString &  aNewProjectBasePath,
const wxString &  aNewProjectName,
const wxString &  aSrcFilePath,
wxString &  aErrors 
)
overridevirtual

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

Reimplemented from KIFACE.

Definition at line 407 of file pcbnew.cpp.

410 {
411  wxFileName destFile( aSrcFilePath );
412  wxString destPath = destFile.GetPathWithSep();
413  wxUniChar pathSep = wxFileName::GetPathSeparator();
414  wxString ext = destFile.GetExt();
415 
416  if( destPath.StartsWith( aProjectBasePath + pathSep ) )
417  destPath.Replace( aProjectBasePath, aNewProjectBasePath, false );
418 
419  wxString srcProjectFootprintLib = pathSep + aSrcProjectName + ".pretty" + pathSep;
420  wxString newProjectFootprintLib = pathSep + aNewProjectName + ".pretty" + pathSep;
421 
422  destPath.Replace( srcProjectFootprintLib, newProjectFootprintLib, true );
423 
424  destFile.SetPath( destPath );
425 
427  {
428  if( destFile.GetName() == aSrcProjectName )
429  destFile.SetName( aNewProjectName );
430 
431  KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
432  }
433  else if( ext == LegacyPcbFileExtension )
434  {
435  if( destFile.GetName() == aSrcProjectName )
436  destFile.SetName( aNewProjectName );
437 
438  KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
439  }
441  {
442  // Footprints are not project-specific. Keep their source names.
443  KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
444  }
445  else if( ext == ComponentFileExtension )
446  {
447  // JEY TODO
448  }
449  else if( ext == "rpt" )
450  {
451  // DRC must be the "gold standard". Since we can't gaurantee that there aren't
452  // any non-deterministic cases in the save-as algorithm, we don't want to certify
453  // the result with the source's DRC report. Therefore copy it under the old
454  // name.
455  KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
456  }
457  else if( destFile.GetName() == "fp-lib-table" )
458  {
459  try
460  {
461  FP_LIB_TABLE fpLibTable;
462  fpLibTable.Load( aSrcFilePath );
463 
464  for( unsigned i = 0; i < fpLibTable.GetCount(); i++ )
465  {
466  LIB_TABLE_ROW& row = fpLibTable.At( i );
467  wxString uri = row.GetFullURI();
468 
469  uri.Replace( "/" + aSrcProjectName + ".pretty", "/" + aNewProjectName + ".pretty" );
470 
471  row.SetFullURI( uri );
472  }
473 
474  fpLibTable.Save( destFile.GetFullPath() );
475  }
476  catch( ... )
477  {
478  wxString msg;
479 
480  if( !aErrors.empty() )
481  aErrors += "\n";
482 
483  msg.Printf( _( "Cannot copy file \"%s\"." ), destFile.GetFullPath() );
484  aErrors += msg;
485  }
486  }
487  else
488  {
489  wxFAIL_MSG( "Unexpected filetype for Pcbnew::SaveFileAs()" );
490  }
491 }
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
const std::string BackupFileSuffix
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 std::string KiCadPcbFileExtension
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.
#define _(s)
Definition: 3d_actions.cpp:33
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.

◆ start_common()

bool KIFACE_I::start_common ( int  aCtlBits)
protectedinherited

Common things to do for a top program module, during OnKifaceStart().

Definition at line 84 of file kiface_i.cpp.

85 {
86  m_start_flags = aCtlBits;
87  m_bm.Init();
89 
90  return true;
91 }
KIWAY::FACE_T m_id
Definition: kiface_i.h:116
void Init()
Definition: bin_mod.cpp:38
BIN_MOD m_bm
Definition: kiface_i.h:118
int m_start_flags
flags provided in OnKifaceStart()
Definition: kiface_i.h:120
SEARCH_STACK m_search
Definition: bin_mod.h:60
static void setSearchPaths(SEARCH_STACK *aDst, KIWAY::FACE_T aId)
Initialize aDst SEARCH_STACK with KIFACE (DSO) specific settings.
Definition: kiface_i.cpp:33

References BIN_MOD::Init(), KIFACE_I::m_bm, KIFACE_I::m_id, BIN_MOD::m_search, KIFACE_I::m_start_flags, and setSearchPaths().

Referenced by BMP2CMP::IFACE::OnKifaceStart(), PCBCALC::IFACE::OnKifaceStart(), IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), CV::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), OnKifaceStart(), and SCH::IFACE::OnKifaceStart().

◆ StartFlags()

int KIFACE_I::StartFlags ( ) const
inlineinherited

Return whatever was passed as aCtlBits to OnKifaceStart().

Definition at line 99 of file kiface_i.h.

99 { return m_start_flags; }
int m_start_flags
flags provided in OnKifaceStart()
Definition: kiface_i.h:120

References KIFACE_I::m_start_flags.


The documentation for this struct was generated from the following file: