KiCad PCB EDA Suite
PCB::IFACE Struct Reference
Inheritance diagram for PCB::IFACE:
KIFACE_BASE 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
 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
 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 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_BASE( aName, aType )
71  {}
KIFACE_BASE(const char *aKifaceName, KIWAY::FACE_T aId)
Definition: kiface_base.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_BASE.

Definition at line 77 of file pcbnew.cpp.

79  {
80  switch( aClassId )
81  {
82  case FRAME_PCB_EDITOR:
83  {
84  auto frame = new PCB_EDIT_FRAME( aKiway, aParent );
85 
86  // give the scripting helpers access to our frame
87  ScriptingSetPcbEditFrame( frame );
88 
89  if( Kiface().IsSingle() )
90  {
91  // only run this under single_top, not under a project manager.
92  frame->CreateServer( KICAD_PCB_PORT_SERVICE_NUMBER );
93  }
94 
95  return frame;
96  }
97 
99  return new FOOTPRINT_EDIT_FRAME( aKiway, aParent,
101 
104  return new FOOTPRINT_VIEWER_FRAME( aKiway, aParent, FRAME_T( aClassId ) );
105 
107  return new FOOTPRINT_WIZARD_FRAME( aKiway, aParent, FRAME_T( aClassId ) );
108 
110  return dynamic_cast< wxWindow* >( FOOTPRINT_PREVIEW_PANEL::New( aKiway, aParent ) );
111 
113  {
114  DIALOG_CONFIGURE_PATHS dlg( aParent, aKiway->Prj().Get3DFilenameResolver() );
115 
116  // The dialog's constructor probably failed to set its Kiway because the
117  // dynamic_cast fails when aParent was allocated by a separate compilation
118  // module. So set it directly.
119  dlg.SetKiway( &dlg, aKiway );
120 
121  // Use QuasiModal so that HTML help window will work
122  if( dlg.ShowQuasiModal() == 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  }
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.
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
Definition: pcbnew.cpp:193
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...
static FOOTPRINT_PREVIEW_PANEL * New(KIWAY *aKiway, wxWindow *aParent)
The main frame for Pcbnew.
bool IsSingle() const
Is this KIFACE running under single_top?
Definition: kiface_base.h:104

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_BASE::IsSingle(), KICAD_PCB_PORT_SERVICE_NUMBER, Kiface(), FOOTPRINT_PREVIEW_PANEL::New(), KIWAY::Prj(), ScriptingSetPcbEditFrame(), and KIWAY_HOLDER::SetKiway().

◆ end_common()

void KIFACE_BASE::end_common ( )
protectedinherited

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

Definition at line 107 of file kiface_base.cpp.

108 {
109  m_bm.End();
110 }
BIN_MOD m_bm
Definition: kiface_base.h:118
void End()
Definition: bin_mod.cpp:50

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

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

◆ GetHelpFileName()

const wxString& KIFACE_BASE::GetHelpFileName ( ) const
inlineinherited

Return just the basename portion of the current help file.

Definition at line 109 of file kiface_base.h.

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

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

Referenced by EDA_BASE_FRAME::help_name().

◆ IfaceOrAddress()

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

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
the object which must be cast into the know type.

Implements KIFACE_BASE.

Definition at line 149 of file pcbnew.cpp.

150  {
151  switch( aDataId )
152  {
153  // Return a pointer to the global instance of the footprint list.
155  return (void*) &GFootprintList;
156 
157  // Return a new FP_LIB_TABLE with the global table installed as a fallback.
159  return (void*) new FP_LIB_TABLE( &GFootprintTable );
160 
161  // Return a pointer to the global instance of the global footprint table.
163  return (void*) &GFootprintTable;
164 
166  return reinterpret_cast<void*>( PyInit__pcbnew );
167 
168  default:
169  return nullptr;
170  }
171  }
Return the global FP_LIB_TABLE.
Definition: kiface_ids.h:53
FP_LIB_TABLE GFootprintTable
The global footprint library table.
Definition: pcbnew.cpp:224
PyObject * PyInit__pcbnew(void)
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:229
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, KIFACE_NEW_FOOTPRINT_TABLE, KIFACE_SCRIPTING_LEGACY, and PyInit__pcbnew().

◆ InitSettings()

void KIFACE_BASE::InitSettings ( APP_SETTINGS_BASE aSettings)
inlineinherited

Definition at line 94 of file kiface_base.h.

94 { m_bm.InitSettings( aSettings ); }
BIN_MOD m_bm
Definition: kiface_base.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_BASE::m_bm.

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

◆ IsSingle()

◆ KifaceSearch()

SEARCH_STACK& KIFACE_BASE::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_base.h.

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

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

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

◆ KifaceSettings()

◆ Name()

const wxString KIFACE_BASE::Name ( )
inlineinherited

Definition at line 87 of file kiface_base.h.

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

References KIFACE_BASE::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_BASE.

Definition at line 277 of file pcbnew.cpp.

278 {
279  end_common();
280 }
void end_common()
Common things to do for a top program module, during OnKifaceEnd();.

References KIFACE_BASE::end_common().

◆ OnKifaceStart()

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

Typically start_common() is called from here.

Implements KIFACE_BASE.

Definition at line 232 of file pcbnew.cpp.

233 {
234  // This is process-level-initialization, not project-level-initialization of the DSO.
235  // Do nothing in here pertinent to a project!
238 
239  start_common( aCtlBits );
240 
241  wxFileName fn = FP_LIB_TABLE::GetGlobalTableFileName();
242 
243  if( !fn.FileExists() )
244  {
245  DIALOG_GLOBAL_FP_LIB_TABLE_CONFIG fpDialog( nullptr );
246 
247  fpDialog.ShowModal();
248  }
249  else
250  {
251  try
252  {
253  // The global table is not related to a specific project. All projects
254  // will use the same global table. So the KIFACE::OnKifaceStart() contract
255  // of avoiding anything project specific is not violated here.
257  return false;
258  }
259  catch( const IO_ERROR& ioe )
260  {
261  // if we are here, a incorrect global footprint library table was found.
262  // Incorrect global symbol library table is not a fatal error:
263  // the user just has to edit the (partially) loaded table.
264  wxString msg = _(
265  "An error occurred attempting to load the global footprint library table.\n"
266  "Please edit this global footprint library table in Preferences menu."
267  );
268 
269  DisplayErrorMessage( nullptr, msg, ioe.What() );
270  }
271  }
272 
273  return true;
274 }
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition: pgm_base.h:129
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:292
T * RegisterSettings(T *aSettings, bool aLoadNow=true)
Takes ownership of the pointer passed in.
FP_LIB_TABLE GFootprintTable
The global footprint library table.
Definition: pcbnew.cpp:224
void InitSettings(APP_SETTINGS_BASE *aSettings)
Definition: kiface_base.h:94
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
static bool LoadGlobalTable(FP_LIB_TABLE &aTable)
Load the global footprint library table into aTable.
bool start_common(int aCtlBits)
Common things to do for a top program module, during OnKifaceStart().
Definition: kiface_base.cpp:97
#define _(s)
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:92
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:199

References _, aProgram, DisplayErrorMessage(), FP_LIB_TABLE::GetGlobalTableFileName(), PGM_BASE::GetSettingsManager(), GFootprintTable, KIFACE_BASE::InitSettings(), KIFACE_BASE::KifaceSettings(), FP_LIB_TABLE::LoadGlobalTable(), SETTINGS_MANAGER::RegisterSettings(), KIFACE_BASE::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

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

286 {
287  wxFileName destFile( aSrcFilePath );
288  wxString destPath = destFile.GetPathWithSep();
289  wxUniChar pathSep = wxFileName::GetPathSeparator();
290  wxString ext = destFile.GetExt();
291 
292  if( destPath.StartsWith( aProjectBasePath + pathSep ) )
293  destPath.Replace( aProjectBasePath, aNewProjectBasePath, false );
294 
295  wxString srcProjectFootprintLib = pathSep + aSrcProjectName + ".pretty" + pathSep;
296  wxString newProjectFootprintLib = pathSep + aNewProjectName + ".pretty" + pathSep;
297 
298  destPath.Replace( srcProjectFootprintLib, newProjectFootprintLib, true );
299 
300  destFile.SetPath( destPath );
301 
303  {
304  if( destFile.GetName() == aSrcProjectName )
305  destFile.SetName( aNewProjectName );
306 
307  KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
308  }
309  else if( ext == LegacyPcbFileExtension )
310  {
311  if( destFile.GetName() == aSrcProjectName )
312  destFile.SetName( aNewProjectName );
313 
314  KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
315  }
317  {
318  // Footprints are not project-specific. Keep their source names.
319  KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
320  }
321  else if( ext == FootprintAssignmentFileExtension )
322  {
323  // JEY TODO
324  }
325  else if( ext == "rpt" )
326  {
327  // DRC must be the "gold standard". Since we can't guarantee that there aren't
328  // any non-deterministic cases in the save-as algorithm, we don't want to certify
329  // the result with the source's DRC report. Therefore copy it under the old
330  // name.
331  KiCopyFile( aSrcFilePath, destFile.GetFullPath(), aErrors );
332  }
333  else if( destFile.GetName() == "fp-lib-table" )
334  {
335  try
336  {
337  FP_LIB_TABLE fpLibTable;
338  fpLibTable.Load( aSrcFilePath );
339 
340  for( unsigned i = 0; i < fpLibTable.GetCount(); i++ )
341  {
342  LIB_TABLE_ROW& row = fpLibTable.At( i );
343  wxString uri = row.GetFullURI();
344 
345  uri.Replace( "/" + aSrcProjectName + ".pretty", "/" + aNewProjectName + ".pretty" );
346 
347  row.SetFullURI( uri );
348  }
349 
350  fpLibTable.Save( destFile.GetFullPath() );
351  }
352  catch( ... )
353  {
354  wxString msg;
355 
356  if( !aErrors.empty() )
357  aErrors += "\n";
358 
359  msg.Printf( _( "Cannot copy file '%s'." ), destFile.GetFullPath() );
360  aErrors += msg;
361  }
362  }
363  else
364  {
365  wxFAIL_MSG( "Unexpected filetype for Pcbnew::SaveFileAs()" );
366  }
367 }
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:326
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...
const std::string FootprintAssignmentFileExtension
#define _(s)
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.

◆ start_common()

bool KIFACE_BASE::start_common ( int  aCtlBits)
protectedinherited

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

Definition at line 97 of file kiface_base.cpp.

98 {
99  m_start_flags = aCtlBits;
100  m_bm.Init();
102 
103  return true;
104 }
BIN_MOD m_bm
Definition: kiface_base.h:118
void Init()
Definition: bin_mod.cpp:38
static void setSearchPaths(SEARCH_STACK *aDst, KIWAY::FACE_T aId)
Initialize aDst SEARCH_STACK with KIFACE (DSO) specific settings.
Definition: kiface_base.cpp:33
int m_start_flags
flags provided in OnKifaceStart()
Definition: kiface_base.h:120
SEARCH_STACK m_search
Definition: bin_mod.h:60
KIWAY::FACE_T m_id
Definition: kiface_base.h:116

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

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

◆ StartFlags()

int KIFACE_BASE::StartFlags ( ) const
inlineinherited

Return whatever was passed as aCtlBits to OnKifaceStart().

Definition at line 99 of file kiface_base.h.

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

References KIFACE_BASE::m_start_flags.


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