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
 Function OnKifaceStart is called just once shortly after the DSO is loaded. More...
 
void OnKifaceEnd () override
 Function OnKifaceEnd is called just once just before the DSO is to be unloaded. More...
 
wxWindow * CreateWindow (wxWindow *aParent, int aClassId, KIWAY *aKiway, int aCtlBits=0) override
 Function CreateWindow creates 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
 Function StartFlags returns whatever was passed as aCtlBits to OnKifaceStart() More...
 
bool IsSingle () const
 Function IsSingle is this KIFACE_I running under single_top? More...
 
const wxString & GetHelpFileName () const
 Function GetHelpFileName returns 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/pcbnew.cpp.

Constructor & Destructor Documentation

◆ IFACE()

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

Definition at line 69 of file pcbnew/pcbnew.cpp.

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

Member Function Documentation

◆ CreateWindow()

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

Function CreateWindow creates 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
wxWindow* - 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/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  if( dlg.ShowModal() == wxID_OK )
123  aKiway->CommonSettingsChanged( true, false );
124 
125  // Dialog has completed; nothing to return.
126  return nullptr;
127  }
128 
130  InvokePcbLibTableEditor( aKiway, aParent );
131  // Dialog has completed; nothing to return.
132  return nullptr;
133 
134  default:
135  return nullptr;
136  }
137  }
FOOTPRINT_WIZARD_FRAME.
void SetKiway(wxWindow *aDest, KIWAY *aKiway)
Function SetKiway.
#define KICAD_PCB_PORT_SERVICE_NUMBER
< Pcbnew listens on this port for commands from Eeschema
Definition: eda_dde.h:39
FRAME_T
Enum FRAME_T is the set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:34
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
Function IsSingle is this KIFACE_I running under single_top?
Definition: kiface_i.h:117
static FOOTPRINT_PREVIEW_PANEL * New(KIWAY *aKiway, wxWindow *aParent)
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
PCB_EDIT_FRAME is the main frame for Pcbnew.

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 99 of file kiface_i.cpp.

100 {
101  m_bm.End();
102 }
BIN_MOD m_bm
Definition: kiface_i.h:132
void End()
Definition: bin_mod.cpp:53

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

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

◆ GetHelpFileName()

const wxString& KIFACE_I::GetHelpFileName ( ) const
inlineinherited

Function GetHelpFileName returns just the basename portion of the current help file.

Definition at line 123 of file kiface_i.h.

123 { return m_bm.m_help_file; }
BIN_MOD m_bm
Definition: kiface_i.h:132
wxString m_help_file
Definition: bin_mod.h:65

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 147 of file pcbnew/pcbnew.cpp.

148  {
149  switch( aDataId )
150  {
151  // Return a pointer to the global instance of the footprint list.
153  return (void*) &GFootprintList;
154 
155  // Return a new FP_LIB_TABLE with the global table installed as a fallback.
157  return (void*) new FP_LIB_TABLE( &GFootprintTable );
158 
159  // Return a pointer to the global instance of the global footprint table.
161  return (void*) &GFootprintTable;
162 
163  default:
164  return nullptr;
165  }
166  }
FP_LIB_TABLE GFootprintTable
The global footprint library table.
Return the global FP_LIB_TABLE.
Definition: kiface_ids.h:53
FOOTPRINT_LIST_IMPL GFootprintList
The global footprint info table.
Return a new FP_LIB_TABLE with the global table installed as a fallback.
Definition: kiface_ids.h:46
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 105 of file kiface_i.h.

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

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

Referenced by BMP2CMP::IFACE::CreateWindow(), CV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), PCBCALC::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), and 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 127 of file kiface_i.h.

127 { return m_bm.m_search; }
BIN_MOD m_bm
Definition: kiface_i.h:132
SEARCH_STACK m_search
Definition: bin_mod.h:67

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

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

◆ KifaceSettings()

◆ Name()

const wxString KIFACE_I::Name ( )
inlineinherited

Definition at line 101 of file kiface_i.h.

101 { return wxString::FromUTF8( m_bm.m_name ); }
BIN_MOD m_bm
Definition: kiface_i.h:132
const char * m_name
name of this binary module, static C string.
Definition: bin_mod.h:62

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

◆ OnKifaceEnd()

void IFACE::OnKifaceEnd ( )
overridevirtual

Function OnKifaceEnd is 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 376 of file pcbnew/pcbnew.cpp.

377 {
378 #if defined( KICAD_SCRIPTING_WXPYTHON )
379  // Restore the thread state and tell Python to cleanup after itself.
380  // wxPython will do its own cleanup as part of that process.
381  // This should only be called if python was setup correctly.
382 
383  if( IsWxPythonLoaded() )
385 #endif
386 
387  end_common();
388 }
void pcbnewFinishPythonScripting()
void end_common()
Common things to do for a top program module, during OnKifaceEnd();.
Definition: kiface_i.cpp:99
bool IsWxPythonLoaded()

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

◆ OnKifaceStart()

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

Function OnKifaceStart is called just once shortly after the DSO is loaded.

It is the second function called, immediately after the KIFACE_GETTER(). However before either of those, static C++ constructors are called. The DSO implementation should do process level initialization here, not project specific since there will be multiple projects open eventually.

Parameters
aProgramis the process block: PGM_BASE*
aCtlBitsconsists of bit flags from the set of KFCTL_* #defines above.
Returns
bool - true if DSO initialized OK, false if not. When returning false, the loader may optionally decide to terminate the process or not, but will not put out any UI because that is the duty of this function to say why it is returning false. Never return false without having reported to the UI why.

Implements KIFACE_I.

Definition at line 327 of file pcbnew/pcbnew.cpp.

328 {
329  // This is process-level-initialization, not project-level-initialization of the DSO.
330  // Do nothing in here pertinent to a project!
333 
334  start_common( aCtlBits );
335 
336  wxFileName fn = FP_LIB_TABLE::GetGlobalTableFileName();
337 
338  if( !fn.FileExists() )
339  {
341 
342  fpDialog.ShowModal();
343  }
344  else
345  {
346  try
347  {
348  // The global table is not related to a specific project. All projects
349  // will use the same global table. So the KIFACE::OnKifaceStart() contract
350  // of avoiding anything project specific is not violated here.
352  return false;
353  }
354  catch( const IO_ERROR& ioe )
355  {
356  // if we are here, a incorrect global footprint library table was found.
357  // Incorrect global symbol library table is not a fatal error:
358  // the user just has to edit the (partially) loaded table.
359  wxString msg = _(
360  "An error occurred attempting to load the global footprint library table.\n"
361  "Please edit this global footprint library table in Preferences menu."
362  );
363 
364  DisplayErrorMessage( NULL, msg, ioe.What() );
365  }
366  }
367 
368 #if defined( KICAD_SCRIPTING )
369  scriptingSetup();
370 #endif
371 
372  return true;
373 }
FP_LIB_TABLE GFootprintTable
The global footprint library table.
bool start_common(int aCtlBits)
Common things to do for a top program module, during OnKifaceStart().
Definition: kiface_i.cpp:89
VTBL_ENTRY SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:175
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:252
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:103
int PGM_BASE * aProgram
#define NULL
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
static bool LoadGlobalTable(FP_LIB_TABLE &aTable)
Function LoadGlobalTable loads 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:105
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
static wxString GetGlobalTableFileName()
Function GetGlobalTableFileName.

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

Definition at line 391 of file pcbnew/pcbnew.cpp.

394 {
395  wxFileName destFile( aSrcFilePath );
396  wxString destPath = destFile.GetPathWithSep();
397  wxUniChar pathSep = wxFileName::GetPathSeparator();
398  wxString ext = destFile.GetExt();
399 
400  if( destPath.StartsWith( aProjectBasePath + pathSep ) )
401  destPath.Replace( aProjectBasePath, aNewProjectBasePath, false );
402 
403  wxString srcProjectFootprintLib = pathSep + aSrcProjectName + ".pretty" + pathSep;
404  wxString newProjectFootprintLib = pathSep + aNewProjectName + ".pretty" + pathSep;
405 
406  destPath.Replace( srcProjectFootprintLib, newProjectFootprintLib, true );
407 
408  destFile.SetPath( destPath );
409 
410  if( ext == "kicad_pcb" || ext == "kicad_pcb-bak" )
411  {
412  if( destFile.GetName() == aSrcProjectName )
413  destFile.SetName( aNewProjectName );
414 
415  CopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
416  }
417  else if( ext == "brd" )
418  {
419  if( destFile.GetName() == aSrcProjectName )
420  destFile.SetName( aNewProjectName );
421 
422  CopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
423  }
424  else if( ext == "mod" || ext == "kicad_mod" )
425  {
426  // Footprints are not project-specific. Keep their source names.
427  CopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
428  }
429  else if( ext == "cmp" )
430  {
431  // JEY TODO
432  }
433  else if( ext == "rpt" )
434  {
435  // DRC must be the "gold standard". Since we can't gaurantee that there aren't
436  // any non-deterministic cases in the save-as algorithm, we don't want to certify
437  // the result with the source's DRC report. Therefore copy it under the old
438  // name.
439  CopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
440  }
441  else if( destFile.GetName() == "fp-lib-table" )
442  {
443  try
444  {
445  FP_LIB_TABLE fpLibTable;
446  fpLibTable.Load( aSrcFilePath );
447 
448  for( unsigned i = 0; i < fpLibTable.GetCount(); i++ )
449  {
450  LIB_TABLE_ROW& row = fpLibTable.At( i );
451  wxString uri = row.GetFullURI();
452 
453  uri.Replace( "/" + aSrcProjectName + ".pretty", "/" + aNewProjectName + ".pretty" );
454 
455  row.SetFullURI( uri );
456  }
457 
458  fpLibTable.Save( destFile.GetFullPath() );
459  }
460  catch( ... )
461  {
462  wxString msg;
463 
464  if( !aErrors.empty() )
465  aErrors += "\n";
466 
467  msg.Printf( _( "Cannot copy file \"%s\"." ), destFile.GetFullPath() );
468  aErrors += msg;
469  }
470  }
471  else
472  {
473  wxFAIL_MSG( "Unexpected filetype for Pcbnew::SaveFileAs()" );
474  }
475 }
Hold a record identifying a library accessed by the appropriate plug in object in the LIB_TABLE.
unsigned GetCount() const
Get the number of rows contained in the table.
void CopyFile(const wxString &aSrcPath, const wxString &aDestPath, wxString &aErrors)
Function CopyFile.
Definition: gestfich.cpp:363
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 89 of file kiface_i.cpp.

90 {
91  m_start_flags = aCtlBits;
92  m_bm.Init();
94 
95  return true;
96 }
KIWAY::FACE_T m_id
Definition: kiface_i.h:130
void Init()
Definition: bin_mod.cpp:41
BIN_MOD m_bm
Definition: kiface_i.h:132
int m_start_flags
flags provided in OnKifaceStart()
Definition: kiface_i.h:134
SEARCH_STACK m_search
Definition: bin_mod.h:67
static void setSearchPaths(SEARCH_STACK *aDst, KIWAY::FACE_T aId)
Initialize aDst SEARCH_STACK with KIFACE (DSO) specific settings.
Definition: kiface_i.cpp:37

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(), IFACE::OnKifaceStart(), CV::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), PCBCALC::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), and OnKifaceStart().

◆ StartFlags()

int KIFACE_I::StartFlags ( ) const
inlineinherited

Function StartFlags returns whatever was passed as aCtlBits to OnKifaceStart()

Definition at line 111 of file kiface_i.h.

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

References KIFACE_I::m_start_flags.


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