KiCad PCB EDA Suite
kiway.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2014 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
5  * Copyright (C) 2014-2017 KiCad Developers, see CHANGELOG.TXT for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #include <string.h>
26 
27 #include <macros.h>
28 #include <kiway.h>
29 #include <kiway_player.h>
30 #include <kiway_express.h>
31 #include <pgm_base.h>
32 #include <config.h>
33 #include <id.h>
34 
35 #include <wx/stdpaths.h>
36 #include <wx/debug.h>
37 #include <wx/utils.h>
38 
39 
40 KIFACE* KIWAY::m_kiface[KIWAY_FACE_COUNT];
41 int KIWAY::m_kiface_version[KIWAY_FACE_COUNT];
42 
43 
44 
45 KIWAY::KIWAY( PGM_BASE* aProgram, int aCtlBits, wxFrame* aTop ):
46  m_program( aProgram ), m_ctl( aCtlBits ), m_top( 0 )
47 {
48  SetTop( aTop ); // hook player_destroy_handler() into aTop.
49 
50 
51  // Prepare the room to store the frame names, once they will be created
52  // with FRAME_T type as index in this table.
53  // (note this is a list of frame names, but a non empty entry
54  // does not mean the frame still exists. It means only the frame was created
55  // at least once. It can be destroyed after. These entries are not cleared.
56  // the purpose is just to allow a call to wxWindow::FindWindowByName(), from
57  // a FRAME_T frame type
58  m_playerFrameName.Add( wxEmptyString, KIWAY_PLAYER_COUNT );
59 }
60 
61 
62 #if 0
63 // Any event types derived from wxCommandEvt, like wxWindowDestroyEvent, are
64 // propagated upwards to parent windows if not handled below. Therefore the
65 // m_top window should receive all wxWindowDestroyEvents originating from
66 // KIWAY_PLAYERs. It does anyways, but now player_destroy_handler eavesdrops
67 // on that event stream looking for KIWAY_PLAYERs being closed.
68 
69 void KIWAY::player_destroy_handler( wxWindowDestroyEvent& event )
70 {
71  // Currently : do nothing
72  event.Skip(); // skip to who, the wxApp? I'm the top window.
73 }
74 #endif
75 
76 
77 void KIWAY::SetTop( wxFrame* aTop )
78 {
79 #if 0
80  if( m_top )
81  {
82  m_top->Disconnect( wxEVT_DESTROY, wxWindowDestroyEventHandler( KIWAY::player_destroy_handler ), NULL, this );
83  }
84 
85  if( aTop )
86  {
87  aTop->Connect( wxEVT_DESTROY, wxWindowDestroyEventHandler( KIWAY::player_destroy_handler ), NULL, this );
88  }
89 #endif
90 
91  m_top = aTop;
92 }
93 
94 
95 const wxString KIWAY::dso_search_path( FACE_T aFaceId )
96 {
97  const char* name;
98 
99  switch( aFaceId )
100  {
101  case FACE_SCH: name = KIFACE_PREFIX "eeschema"; break;
102  case FACE_PCB: name = KIFACE_PREFIX "pcbnew"; break;
103  case FACE_CVPCB: name = KIFACE_PREFIX "cvpcb"; break;
104  case FACE_GERBVIEW: name = KIFACE_PREFIX "gerbview"; break;
105  case FACE_PL_EDITOR: name = KIFACE_PREFIX "pl_editor"; break;
106  case FACE_PCB_CALCULATOR: name = KIFACE_PREFIX "pcb_calculator"; break;
107  case FACE_BMP2CMP: name = KIFACE_PREFIX "bitmap2component"; break;
108 
109  default:
110  wxASSERT_MSG( 0, wxT( "caller has a bug, passed a bad aFaceId" ) );
111  return wxEmptyString;
112  }
113 
114 #ifndef __WXMAC__
115  wxString path;
116 
118  {
119  // The 2 *.cpp program launchers: single_top.cpp and kicad.cpp expect
120  // the *.kiface's to reside in same diretory as their binaries do.
121  // Not so for python launcher, identified by KFCTL_PY_PROJECT_SUITE
122  path = wxStandardPaths::Get().GetExecutablePath();
123  }
124 
125  wxFileName fn = path;
126 #else
127  // we have the dso's in main OSX bundle kicad.app/Contents/PlugIns
128  wxFileName fn = Pgm().GetExecutablePath();
129  fn.AppendDir( wxT( "Contents" ) );
130  fn.AppendDir( wxT( "PlugIns" ) );
131 #endif
132 
133  fn.SetName( name );
134 
135 #ifdef DEBUG
136  // To speed up development, it's sometimes nice to run kicad from inside
137  // the build path. In that case, each program will be in a subdirectory.
138  // To find the DSOs, we need to go up one directory and then enter a subdirectory
139  // with the same name as the DSO (without the prefix).
140 
141  if( wxGetEnv( wxT( "KICAD_RUN_FROM_BUILD_DIR" ), nullptr ) )
142  {
143 #ifdef __WXMAC__
144  fn = wxStandardPaths::Get().GetExecutablePath();
145  fn.RemoveLastDir();
146  fn.AppendDir( wxT( "PlugIns" ) );
147  fn.SetName( name );
148 #else
149  fn.RemoveLastDir();
150  fn.AppendDir( name + 1 );
151 #endif
152  }
153 #endif
154 
155  // Here a "suffix" == an extension with a preceding '.',
156  // so skip the preceding '.' to get an extension
157  fn.SetExt( KIFACE_SUFFIX + 1 ); // + 1 => &KIFACE_SUFFIX[1]
158 
159  return fn.GetFullPath();
160 }
161 
162 
164 {
165  return *(PROJECT*) &m_project; // strip const-ness, function really is const.
166 }
167 
168 
169 KIFACE* KIWAY::KiFACE( FACE_T aFaceId, bool doLoad )
170 {
171  // Since this will be called from python, cannot assume that code will
172  // not pass a bad aFaceId.
173  if( (unsigned) aFaceId >= arrayDim( m_kiface ) )
174  {
175  // @todo : throw an exception here for python's benefit, at least that
176  // way it gets some explanatory text.
177 
178  wxASSERT_MSG( 0, wxT( "caller has a bug, passed a bad aFaceId" ) );
179  return NULL;
180  }
181 
182  // return the previously loaded KIFACE, if it was.
183  if( m_kiface[aFaceId] )
184  return m_kiface[aFaceId];
185 
186  wxString msg;
187 
188  // DSO with KIFACE has not been loaded yet, does caller want to load it?
189  if( doLoad )
190  {
191  wxString dname = dso_search_path( aFaceId );
192 
193  wxDynamicLibrary dso;
194 
195  void* addr = NULL;
196 
197  if( !dso.Load( dname, wxDL_VERBATIM | wxDL_NOW | wxDL_GLOBAL ) )
198  {
199  // Failure: error reporting UI was done via wxLogSysError().
200  // No further reporting required here. Apparently this is not true on all
201  // platforms and/or wxWidgets builds and KiCad will crash. Throwing the exception
202  // here and catching it in the KiCad launcher resolves the crash issue. See bug
203  // report https://bugs.launchpad.net/kicad/+bug/1577786.
204 
205  msg.Printf( _( "Failed to load kiface library \"%s\"." ), GetChars( dname ) );
206  THROW_IO_ERROR( msg );
207  }
208  else if( ( addr = dso.GetSymbol( wxT( KIFACE_INSTANCE_NAME_AND_VERSION ) ) ) == NULL )
209  {
210  // Failure: error reporting UI was done via wxLogSysError().
211  // No further reporting required here. Assume the same thing applies here as
212  // above with the Load() call. This has not been tested.
213  msg.Printf(
214  _( "Could not read instance name and version symbol form kiface library \"%s\"." ),
215  GetChars( dname ) );
216  THROW_IO_ERROR( msg );
217  }
218  else
219  {
220  KIFACE_GETTER_FUNC* getter = (KIFACE_GETTER_FUNC*) addr;
221 
222  KIFACE* kiface = getter( &m_kiface_version[aFaceId], KIFACE_VERSION, m_program );
223 
224  // KIFACE_GETTER_FUNC function comment (API) says the non-NULL is unconditional.
225  wxASSERT_MSG( kiface,
226  wxT( "attempted DSO has a bug, failed to return a KIFACE*" ) );
227 
228  // Give the DSO a single chance to do its "process level" initialization.
229  // "Process level" specifically means stay away from any projects in there.
230  if( kiface->OnKifaceStart( m_program, m_ctl ) )
231  {
232  // Tell dso's wxDynamicLibrary destructor not to Unload() the program image.
233  (void) dso.Detach();
234 
235  return m_kiface[aFaceId] = kiface;
236  }
237  }
238 
239  // In any of the failure cases above, dso.Unload() should be called here
240  // by dso destructor.
241  // However:
242 
243  // There is a file installation bug. We only look for KIFACE_I's which we know
244  // to exist, and we did not find one. If we do not find one, this is an
245  // installation bug.
246 
247  msg = wxString::Format( _(
248  "Fatal Installation Bug. File:\n"
249  "\"%s\"\ncould not be loaded\n" ), GetChars( dname ) );
250 
251  if( ! wxFileExists( dname ) )
252  msg << _( "It is missing.\n" );
253  else
254  msg << _( "Perhaps a shared library (.dll or .so) file is missing.\n" );
255 
256  msg << _( "From command line: argv[0]:\n'" );
257  msg << wxStandardPaths::Get().GetExecutablePath() << wxT( "'\n" );
258 
259  // This is a fatal error, one from which we cannot recover, nor do we want
260  // to protect against in client code which would require numerous noisy
261  // tests in numerous places. So we inform the user that the installation
262  // is bad. This exception will likely not get caught until way up in the
263  // wxApp derivative, at which point the process will exit gracefully.
264  THROW_IO_ERROR( msg );
265  }
266 
267  return NULL;
268 }
269 
270 
272 {
273  switch( aFrameType )
274  {
275  case FRAME_SCH:
277  case FRAME_SCH_VIEWER:
279  case FRAME_SIMULATOR:
280  return FACE_SCH;
281 
282  case FRAME_PCB:
287  case FRAME_PCB_DISPLAY3D:
288  return FACE_PCB;
289 
290  case FRAME_CVPCB:
291  case FRAME_CVPCB_DISPLAY:
292  return FACE_CVPCB;
293 
294  case FRAME_GERBER:
295  return FACE_GERBVIEW;
296 
297  case FRAME_PL_EDITOR:
298  return FACE_PL_EDITOR;
299 
300  case FRAME_CALC:
301  return FACE_PCB_CALCULATOR;
302 
303  case FRAME_BM2CMP:
304  return FACE_BMP2CMP;
305 
306  default:
307  return FACE_T( -1 );
308  }
309 }
310 
311 
313 {
314  if( m_playerFrameName[aFrameType].IsEmpty() )
315  return NULL;
316 
317  return static_cast<KIWAY_PLAYER*>( wxWindow::FindWindowByName( m_playerFrameName[aFrameType] ) );
318 }
319 
320 
321 KIWAY_PLAYER* KIWAY::Player( FRAME_T aFrameType, bool doCreate, wxTopLevelWindow* aParent )
322 {
323  // Since this will be called from python, cannot assume that code will
324  // not pass a bad aFrameType.
325  if( (unsigned) aFrameType >= KIWAY_PLAYER_COUNT )
326  {
327  // @todo : throw an exception here for python's benefit, at least that
328  // way it gets some explanatory text.
329 
330  wxASSERT_MSG( 0, wxT( "caller has a bug, passed a bad aFrameType" ) );
331  return NULL;
332  }
333 
334  // return the previously opened window
335  KIWAY_PLAYER* frame = GetPlayerFrame( aFrameType );
336 
337  if( frame )
338  return frame;
339 
340  if( doCreate )
341  {
342  FACE_T face_type = KifaceType( aFrameType );
343  wxASSERT( face_type != FACE_T(-1) );
344 
345  KIFACE* kiface = KiFACE( face_type );
346  wxASSERT( kiface );
347 
348  if( kiface )
349  {
350  frame = (KIWAY_PLAYER*) kiface->CreateWindow(
351  aParent, // Parent window of frame in modal mode, NULL in non modal mode
352  aFrameType,
353  this,
354  m_ctl // questionable need, these same flags where passed
355  // to the KIFACE::OnKifaceStart()
356  );
357  wxASSERT( frame );
358 
359  m_playerFrameName[aFrameType] = frame->GetName();
360 
361  return frame;
362  }
363  }
364 
365  return NULL;
366 }
367 
368 
369 bool KIWAY::PlayerClose( FRAME_T aFrameType, bool doForce )
370 {
371  // Since this will be called from python, cannot assume that code will
372  // not pass a bad aFrameType.
373  if( (unsigned) aFrameType >= KIWAY_PLAYER_COUNT )
374  {
375  // @todo : throw an exception here for python's benefit, at least that
376  // way it gets some explanatory text.
377 
378  wxASSERT_MSG( 0, wxT( "caller has a bug, passed a bad aFrameType" ) );
379  return false;
380  }
381 
382  KIWAY_PLAYER* frame = GetPlayerFrame( aFrameType );
383 
384  if( frame == NULL ) // Already closed
385  return true;
386 
387  if( frame->Close( doForce ) )
388  return true;
389 
390  return false;
391 }
392 
393 
394 bool KIWAY::PlayersClose( bool doForce )
395 {
396  bool ret = true;
397 
398  for( unsigned i=0; i < KIWAY_PLAYER_COUNT; ++i )
399  {
400  ret = ret && PlayerClose( FRAME_T( i ), doForce );
401  }
402 
403  return ret;
404 }
405 
406 
407 void KIWAY::ExpressMail( FRAME_T aDestination, MAIL_T aCommand, std::string& aPayload, wxWindow* aSource )
408 {
409  KIWAY_EXPRESS mail( aDestination, aCommand, aPayload, aSource );
410 
411  ProcessEvent( mail );
412 }
413 
414 
415 void KIWAY::SetLanguage( int aLanguage )
416 {
417  Pgm().SetLanguageIdentifier( aLanguage );
418  Pgm().SetLanguage();
419 
420 #if 1
421  // This is a risky hack that goes away if we allow the language to be
422  // set only from the top most frame if !Kiface.IsSingle()
423 
424  // Only for the C++ project manager, and not for the python one and not for
425  // single_top do we look for the EDA_BASE_FRAME as the top level window.
426  // For single_top this is not needed because that window is registered in
427  // the array below.
429  {
430  // A dynamic_cast could be better, but creates link issues
431  // (some basic_frame functions not found) on some platforms,
432  // so a static_cast is used.
433  EDA_BASE_FRAME* top = static_cast<EDA_BASE_FRAME*>( m_top );
434 
435  if( top )
436  top->ShowChangedLanguage();
437  }
438 #endif
439 
440  for( unsigned i=0; i < KIWAY_PLAYER_COUNT; ++i )
441  {
442  KIWAY_PLAYER* frame = GetPlayerFrame( ( FRAME_T )i );
443 
444  if( frame )
445  {
446  frame->ShowChangedLanguage();
447  }
448  }
449 }
450 
451 void KIWAY::CommonSettingsChanged( bool aEnvVarsChanged )
452 {
453 #if 1
455  {
456  // A dynamic_cast could be better, but creates link issues
457  // (some basic_frame functions not found) on some platforms,
458  // so a static_cast is used.
459  EDA_BASE_FRAME* top = static_cast<EDA_BASE_FRAME*>( m_top );
460 
461  if( top )
462  top->CommonSettingsChanged( aEnvVarsChanged );
463  }
464 #endif
465 
466  for( unsigned i=0; i < KIWAY_PLAYER_COUNT; ++i )
467  {
468  KIWAY_PLAYER* frame = GetPlayerFrame( ( FRAME_T )i );
469 
470  if( frame )
471  frame->CommonSettingsChanged( aEnvVarsChanged );
472  }
473 }
474 
475 
476 bool KIWAY::ProcessEvent( wxEvent& aEvent )
477 {
478  KIWAY_EXPRESS* mail = dynamic_cast<KIWAY_EXPRESS*>( &aEvent );
479 
480  if( mail )
481  {
482  FRAME_T dest = mail->Dest();
483 
484  // see if recipient is alive
485  KIWAY_PLAYER* alive = Player( dest, false );
486 
487  if( alive )
488  {
489 #if 1
490  return alive->ProcessEvent( aEvent );
491 #else
492  alive->KiwayMailIn( *mail );
493  return true;
494 #endif
495  }
496  }
497 
498  return false;
499 }
500 
501 
503 {
505  {
506  // A dynamic_cast could be better, but creates link issues
507  // (some basic_frame functions not found) on some platforms,
508  // so a static_cast is used.
509  EDA_BASE_FRAME* top = static_cast<EDA_BASE_FRAME*>( m_top );
510 
511  if( top )
512  top->Close( false );
513  }
514 }
515 
516 
518 {
519  for( KIFACE* i : m_kiface )
520  {
521  if( i )
522  i->OnKifaceEnd();
523  }
524 }
#define KFCTL_CPP_PROJECT_SUITE
Am running under C++ project mgr, possibly with others.
Definition: kiway.h:160
VTBL_ENTRY bool PlayersClose(bool doForce)
Function PlayersClose calls the KIWAY_PLAYER::Close( bool force ) function on all the windows and if ...
Definition: kiway.cpp:394
Class KIWAY_PLAYER is a wxFrame capable of the OpenProjectFiles function, meaning it can load a porti...
Definition: kiway_player.h:59
Class KIWAY_EXPRESS carries a payload from one KIWAY_PLAYER to another within a PROJECT.
Definition: kiway_express.h:39
void OnKiCadExit()
Definition: kiway.cpp:502
Class PROJECT holds project specific data.
Definition: project.h:58
static FACE_T KifaceType(FRAME_T aFrameType)
Function KifaceType is a simple mapping function which returns the FACE_T which is known to implement...
Definition: kiway.cpp:271
KIWAY_PLAYER * GetPlayerFrame(FRAME_T aFrameType)
Definition: kiway.cpp:312
VTBL_ENTRY void CommonSettingsChanged(bool aEnvVarsChanged)
Function CommonSettingsChanged Calls CommonSettingsChanged() on all KIWAY_PLAYERs.
Definition: kiway.cpp:451
Class PGM_BASE keeps program (whole process) data for KiCad programs.
Definition: pgm_base.h:166
#define KIFACE_VERSION
Definition: kiway.h:111
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
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:163
KIWAY(PGM_BASE *aProgram, int aCtlBits, wxFrame *aTop=NULL)
Definition: kiway.cpp:45
PGM_BASE * m_program
Definition: kiway.h:417
PGM_BASE & Pgm()
The global Program "get" accessor.
Definition: kicad.cpp:65
VTBL_ENTRY void SetLanguage(int aLanguage)
Function SetLanguage changes the language and then calls ShowChangedLanguage() on all KIWAY_PLAYERs.
Definition: kiway.cpp:415
void OnKiwayEnd()
Definition: kiway.cpp:517
#define KIFACE_INSTANCE_NAME_AND_VERSION
Definition: kiway.h:116
This file contains miscellaneous commonly used macros and functions.
MAIL_T
Enum MAIL_T is the set of mail types sendable via KIWAY::ExpressMail() and supplied as the aCommand p...
Definition: mail_type.h:37
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:321
VTBL_ENTRY void SetLanguageIdentifier(int menu_id)
Function SetLanguageIdentifier sets in .m_language_id member the wxWidgets language identifier Id fro...
Definition: pgm_base.cpp:743
VTBL_ENTRY bool PlayerClose(FRAME_T aFrameType, bool doForce)
Function PlayerClose calls the KIWAY_PLAYER::Close( bool force ) function on the window and if not ve...
Definition: kiway.cpp:369
bool ProcessEvent(wxEvent &aEvent) override
Definition: kiway.cpp:476
KIFACE * KIFACE_GETTER_FUNC(int *aKIFACEversion, int aKIWAYversion, PGM_BASE *aProgram)
Function Pointer KIFACE_GETTER_FUNC points to the one and only KIFACE export.
Definition: kiway.h:454
PROJECT m_project
Definition: kiway.h:430
int m_ctl
Definition: kiway.h:418
virtual void KiwayMailIn(KIWAY_EXPRESS &aEvent)
Function KiwayMailIn receives KIWAY_EXPRESS messages from other players.
pcbnew DSO
Definition: kiway.h:267
#define THROW_IO_ERROR(msg)
const wxString dso_search_path(FACE_T aFaceId)
Get the [path &] name of the DSO holding the requested FACE_T.
Definition: kiway.cpp:95
VTBL_ENTRY KIFACE * KiFACE(FACE_T aFaceId, bool doLoad=true)
Function KiFACE returns the KIFACE* given a FACE_T.
Definition: kiway.cpp:169
void SetTop(wxFrame *aTop)
Function SetTop tells this KIWAY about the top most frame in the program and optionally allows it to ...
Definition: kiway.cpp:77
#define _(s)
VTBL_ENTRY bool SetLanguage(bool first_time=false)
Function SetLanguage sets the dictionary file name for internationalization.
Definition: pgm_base.cpp:651
FACE_T
Known KIFACE implementations.
Definition: kiway.h:264
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Definition: macros.h:108
eeschema DSO
Definition: kiway.h:266
virtual void CommonSettingsChanged(bool aEnvVarsChanged)
Notification event that some of the common (suite-wide) settings have changed.
VTBL_ENTRY void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=NULL)
Function ExpressMail send aPayload to aDestination from aSource.
Definition: kiway.cpp:407
FRAME_T Dest()
Function Dest returns the destination player id of the message.
Definition: kiway_express.h:46
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
see class PGM_BASE
const char * name
Definition: DXF_plotter.cpp:61
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
VTBL_ENTRY const wxString & GetExecutablePath() const
Definition: pgm_base.h:232
The base frame for deriving all KiCad main window classes.
size_t i
Definition: json11.cpp:597
Class KIFACE is used by a participant in the KIWAY alchemy.
Definition: kiway.h:151
static int m_kiface_version[KIWAY_FACE_COUNT]
Definition: kiway.h:415
wxArrayString m_playerFrameName
Definition: kiway.h:428
return & kiface
Definition: pcbnew.cpp:186
wxFrame * m_top
Definition: kiway.h:420
virtual void ShowChangedLanguage()
Redraw the menus and what not in current language.
bool ProcessEvent(wxEvent &aEvent) override
Override the default process event handler to implement the auto save feature.
int PGM_BASE * aProgram
Definition: pcbnew.cpp:184
static KIFACE * m_kiface[KIWAY_FACE_COUNT]
Definition: kiway.h:414
#define KFCTL_STANDALONE
Am running as a standalone Top.
Definition: kiway.h:159