KiCad PCB EDA Suite
kiway.h
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 <[email protected]>
5 * Copyright (C) 2016-2020 KiCad Developers, see AUTHORS.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#ifndef KIWAY_H_
26#define KIWAY_H_
27
98#include <atomic>
99#include <wx/defs.h>
100#include <wx/event.h>
101#include <import_export.h>
102#include <search_stack.h>
103#include <project.h>
104#include <frame_type.h>
105#include <mail_type.h>
106#include <ki_exception.h>
107#include <jobs/job.h>
108
109
110#define KIFACE_VERSION 1
111#define KIFACE_GETTER KIFACE_1
112
113// The KIFACE acquisition function is declared extern "C" so its name should not
114// be mangled.
115#define KIFACE_INSTANCE_NAME_AND_VERSION "KIFACE_1"
116
117#ifndef SWIG
118#if defined(__linux__) || defined(__FreeBSD__)
119 #define LIB_ENV_VAR wxT( "LD_LIBRARY_PATH" )
120#elif defined(__WXMAC__)
121 #define LIB_ENV_VAR wxT( "DYLD_LIBRARY_PATH" )
122#elif defined(_WIN32)
123 #define LIB_ENV_VAR wxT( "PATH" )
124#else
125 #error Platform support missing
126#endif
127#endif // SWIG
128
129class wxConfigBase;
130class wxWindow;
131class PGM_BASE;
132class KIWAY;
133class KIWAY_PLAYER;
134class wxTopLevelWindow;
135class TOOL_ACTION;
136
137
150struct KIFACE
151{
152 // The order of functions establishes the vtable sequence, do not change the
153 // order of functions in this listing unless you recompile all clients of
154 // this interface.
155
156 virtual ~KIFACE() throw() {}
157
158#define KFCTL_STANDALONE ( 1 << 0 )
159#define KFCTL_CPP_PROJECT_SUITE ( 1 << 1 )
160#define KFCTL_CLI ( 1 << 2 )
161
162
177 virtual bool OnKifaceStart( PGM_BASE* aProgram, int aCtlBits ) = 0;
178
185 virtual void OnKifaceEnd() = 0;
186
203 virtual wxWindow* CreateKiWindow( wxWindow* aParent, int aClassId,
204 KIWAY* aKIWAY, int aCtlBits = 0 ) = 0;
205
211 virtual void SaveFileAs( const wxString& srcProjectBasePath,
212 const wxString& srcProjectName,
213 const wxString& newProjectBasePath,
214 const wxString& newProjectName,
215 const wxString& srcFilePath,
216 wxString& aErrors )
217 {
218 // If a KIFACE owns files then it needs to implement this....
219 }
220
232 virtual void* IfaceOrAddress( int aDataId ) = 0;
233
237 virtual void GetActions( std::vector<TOOL_ACTION*>& aActions ) const = 0;
238
239 virtual int HandleJob( JOB* aJob )
240 {
241 return 0;
242 }
243};
244
245
273class KIWAY : public wxEvtHandler
274{
275 friend struct PGM_SINGLE_TOP; // can use set_kiface()
276
277public:
280 {
289
291 };
292
293 ~KIWAY() throw () {}
294
301 static FACE_T KifaceType( FRAME_T aFrameType );
302
303 // If you change the vtable, recompile all of KiCad.
304
311 virtual KIFACE* KiFACE( FACE_T aFaceId, bool doLoad = true );
312
332 virtual KIWAY_PLAYER* Player( FRAME_T aFrameType, bool doCreate = true,
333 wxTopLevelWindow* aParent = nullptr );
334
343 virtual bool PlayerClose( FRAME_T aFrameType, bool doForce );
344
354 virtual bool PlayersClose( bool doForce );
355
362 virtual void ExpressMail( FRAME_T aDestination, MAIL_T aCommand, std::string& aPayload,
363 wxWindow* aSource = nullptr );
364
368 virtual void GetActions( std::vector<TOOL_ACTION*>& aActions ) const;
369
376 virtual PROJECT& Prj() const;
377
381 virtual void SetLanguage( int aLanguage );
382
388 virtual void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged );
389
394 virtual void ProjectChanged();
395
396 KIWAY( PGM_BASE* aProgram, int aCtlBits, wxFrame* aTop = nullptr );
397
402 void SetCtlBits( int aCtlBits ) { m_ctl = aCtlBits; }
403
410 void SetTop( wxFrame* aTop );
411 wxFrame* GetTop() { return m_top; }
412
413 void OnKiCadExit();
414
415 void OnKiwayEnd();
416
417 bool ProcessEvent( wxEvent& aEvent ) override;
418
419 int ProcessJob( KIWAY::FACE_T aFace, JOB* job );
420
425 wxWindow* GetBlockingDialog();
426 void SetBlockingDialog( wxWindow* aWin );
427
428private:
430 const wxString dso_search_path( FACE_T aFaceId );
431
432#if 0
434 void player_destroy_handler( wxWindowDestroyEvent& event );
435#endif
436
437 bool set_kiface( FACE_T aFaceType, KIFACE* aKiface )
438 {
439 if( (unsigned) aFaceType < (unsigned) KIWAY_FACE_COUNT )
440 {
441 m_kiface[aFaceType] = aKiface;
442 return true;
443 }
444
445 return false;
446 }
447
452 KIWAY_PLAYER* GetPlayerFrame( FRAME_T aFrameType );
453
456
458 int m_ctl;
459
460 wxFrame* m_top; // Usually m_top is the Project manager
461
463
464 // An array to store the window ID of PLAYER frames which were run.
465 // A non empty name means only a PLAYER was run at least one time.
466 // Empty entries are represented by wxID_NONE.
467 // They can be closed, and the stored window ID may be invalid.
468 // Call: wxWindow::FindWindowById( m_playerFrameId[aFrameType] )
469 // to know if still exists (or GetPlayerFrame( FRAME_T aFrameType )
470 std::atomic<wxWindowID> m_playerFrameId[KIWAY_PLAYER_COUNT];
471};
472
473
474#ifndef SWIG
475// provided by single_top.cpp and kicad.cpp;
476extern KIWAY Kiway;
477// whereas python launchers: single_top.py and project manager instantiate as a python object
478#endif
479
480
493typedef KIFACE* KIFACE_GETTER_FUNC( int* aKIFACEversion, int aKIWAYversion, PGM_BASE* aProgram );
494
495
496#ifndef SWIG
497
499extern "C" {
500#if defined(BUILD_KIWAY_DLL)
501 MY_API( KIFACE* ) KIFACE_GETTER( int* aKIFACEversion, int aKIWAYversion, PGM_BASE* aProgram );
502#else
503 KIFACE* KIFACE_GETTER( int* aKIFACEversion, int aKIWAYversion, PGM_BASE* aProgram );
504#endif
505}
506
507#endif // SWIG
508
509#endif // KIWAY_H_
An simple container class that lets us dispatch output jobs to kifaces.
Definition: job.h:28
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
Definition: kiway_player.h:66
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:274
void OnKiCadExit()
Definition: kiway.cpp:668
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Call CommonSettingsChanged() on all KIWAY_PLAYERs.
Definition: kiway.cpp:575
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:394
const wxString dso_search_path(FACE_T aFaceId)
Get the [path &] name of the DSO holding the requested FACE_T.
Definition: kiway.cpp:106
int ProcessJob(KIWAY::FACE_T aFace, JOB *job)
Definition: kiway.cpp:660
PGM_BASE * m_program
Definition: kiway.h:457
void SetCtlBits(int aCtlBits)
Overwrites previously set ctl bits, only for use in kicad.cpp to flip between standalone and manager ...
Definition: kiway.h:402
void SetBlockingDialog(wxWindow *aWin)
Definition: kiway.cpp:625
virtual bool PlayerClose(FRAME_T aFrameType, bool doForce)
Call the KIWAY_PLAYER::Close( bool force ) function on the window and if not vetoed,...
Definition: kiway.cpp:450
static FACE_T KifaceType(FRAME_T aFrameType)
A simple mapping function which returns the FACE_T which is known to implement aFrameType.
Definition: kiway.cpp:332
wxWindowID m_blockingDialog
Definition: kiway.h:462
bool set_kiface(FACE_T aFaceType, KIFACE *aKiface)
Definition: kiway.h:437
KIWAY(PGM_BASE *aProgram, int aCtlBits, wxFrame *aTop=nullptr)
Definition: kiway.cpp:53
wxWindow * GetBlockingDialog()
Gets the window pointer to the blocking dialog (to send it signals)
Definition: kiway.cpp:620
static KIFACE * m_kiface[KIWAY_FACE_COUNT]
Definition: kiway.h:454
wxFrame * m_top
Definition: kiway.h:460
wxFrame * GetTop()
Definition: kiway.h:411
virtual void SetLanguage(int aLanguage)
Change the language and then calls ShowChangedLanguage() on all #KIWAY_PLAYERs.
Definition: kiway.cpp:507
virtual KIFACE * KiFACE(FACE_T aFaceId, bool doLoad=true)
Return the KIFACE* given a FACE_T.
Definition: kiway.cpp:198
FACE_T
Known KIFACE implementations.
Definition: kiway.h:280
@ KIWAY_FACE_COUNT
Definition: kiway.h:290
@ FACE_SCH
eeschema DSO
Definition: kiway.h:281
@ FACE_PL_EDITOR
Definition: kiway.h:285
@ FACE_PYTHON
Definition: kiway.h:288
@ FACE_PCB
pcbnew DSO
Definition: kiway.h:282
@ FACE_CVPCB
Definition: kiway.h:283
@ FACE_GERBVIEW
Definition: kiway.h:284
@ FACE_BMP2CMP
Definition: kiway.h:287
@ FACE_PCB_CALCULATOR
Definition: kiway.h:286
static int m_kiface_version[KIWAY_FACE_COUNT]
Definition: kiway.h:455
KIWAY_PLAYER * GetPlayerFrame(FRAME_T aFrameType)
Definition: kiway.cpp:376
bool ProcessEvent(wxEvent &aEvent) override
Definition: kiway.cpp:634
virtual bool PlayersClose(bool doForce)
Call the KIWAY_PLAYER::Close( bool force ) function on all the windows and if none are vetoed,...
Definition: kiway.cpp:478
std::atomic< wxWindowID > m_playerFrameId[KIWAY_PLAYER_COUNT]
Definition: kiway.h:470
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
Definition: kiway.cpp:491
void OnKiwayEnd()
Definition: kiway.cpp:683
~KIWAY()
Definition: kiway.h:293
virtual void GetActions(std::vector< TOOL_ACTION * > &aActions) const
Append all registered actions to the given list.
Definition: kiway.cpp:500
void SetTop(wxFrame *aTop)
Tell this KIWAY about the top most frame in the program and optionally allows it to play the role of ...
Definition: kiway.cpp:84
virtual void ProjectChanged()
Calls ProjectChanged() on all KIWAY_PLAYERs.
Definition: kiway.cpp:598
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Definition: kiway.cpp:192
int m_ctl
Definition: kiway.h:458
Container for data for KiCad programs.
Definition: pgm_base.h:95
Container for project specific data.
Definition: project.h:64
Represent a single user action.
Definition: tool_action.h:68
int aKIWAYversion
Definition: cvpcb.cpp:109
int PGM_BASE * aProgram
Definition: cvpcb.cpp:110
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
Definition: frame_type.h:33
@ KIWAY_PLAYER_COUNT
Definition: frame_type.h:61
#define MY_API(rettype)
Definition: import_export.h:55
KIWAY Kiway
KIFACE * KIFACE_GETTER_FUNC(int *aKIFACEversion, int aKIWAYversion, PGM_BASE *aProgram)
Point to the one and only KIFACE export.
Definition: kiway.h:493
#define KIFACE_GETTER
Definition: kiway.h:111
MAIL_T
The set of mail types sendable via KIWAY::ExpressMail() and supplied as the aCommand parameter to tha...
Definition: mail_type.h:38
Implement a participant in the KIWAY alchemy.
Definition: kiway.h:151
virtual wxWindow * CreateKiWindow(wxWindow *aParent, int aClassId, KIWAY *aKIWAY, int aCtlBits=0)=0
Create a wxWindow for the current project.
virtual void OnKifaceEnd()=0
Called just once just before the DSO is to be unloaded.
virtual void * IfaceOrAddress(int aDataId)=0
Return pointer to the requested object.
virtual void SaveFileAs(const wxString &srcProjectBasePath, const wxString &srcProjectName, const wxString &newProjectBasePath, const wxString &newProjectName, const wxString &srcFilePath, wxString &aErrors)
Saving a file under a different name is delegated to the various KIFACEs because the project doesn't ...
Definition: kiway.h:211
virtual void GetActions(std::vector< TOOL_ACTION * > &aActions) const =0
Append this Kiface's registered actions to the given list.
virtual int HandleJob(JOB *aJob)
Definition: kiway.h:239
virtual bool OnKifaceStart(PGM_BASE *aProgram, int aCtlBits)=0
Called just once shortly after the DSO is loaded.
virtual ~KIFACE()
Definition: kiway.h:156
Struct PGM_SINGLE_TOP implements PGM_BASE with its own OnPgmInit() and OnPgmExit().
Definition: single_top.cpp:67