KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 The 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
108
109#define KIFACE_VERSION 1
110#define KIFACE_GETTER KIFACE_1
111
112// The KIFACE acquisition function is declared extern "C" so its name should not
113// be mangled.
114#define KIFACE_INSTANCE_NAME_AND_VERSION "KIFACE_1"
115
116#ifndef SWIG
117#if defined(__linux__) || defined(__FreeBSD__)
118 #define LIB_ENV_VAR wxT( "LD_LIBRARY_PATH" )
119#elif defined(__WXMAC__)
120 #define LIB_ENV_VAR wxT( "DYLD_LIBRARY_PATH" )
121#elif defined(_WIN32)
122 #define LIB_ENV_VAR wxT( "PATH" )
123#else
124 #error Platform support missing
125#endif
126#endif // SWIG
127
128class wxConfigBase;
129class wxWindow;
130class PGM_BASE;
131class KIWAY;
132class KIWAY_PLAYER;
133class wxTopLevelWindow;
134class TOOL_ACTION;
135class JOB;
136class REPORTER;
138
139
152struct KIFACE
153{
154 // The order of functions establishes the vtable sequence, do not change the
155 // order of functions in this listing unless you recompile all clients of
156 // this interface.
157
158 virtual ~KIFACE() throw() {}
159
160#define KFCTL_STANDALONE ( 1 << 0 )
161#define KFCTL_CPP_PROJECT_SUITE ( 1 << 1 )
162#define KFCTL_CLI ( 1 << 2 )
163
164
179 virtual bool OnKifaceStart( PGM_BASE* aProgram, int aCtlBits, KIWAY* aKiway ) = 0;
180
187 virtual void OnKifaceEnd() = 0;
188
192 virtual void Reset() = 0;
193
210 virtual wxWindow* CreateKiWindow( wxWindow* aParent, int aClassId,
211 KIWAY* aKIWAY, int aCtlBits = 0 ) = 0;
212
218 virtual void SaveFileAs( const wxString& srcProjectBasePath,
219 const wxString& srcProjectName,
220 const wxString& newProjectBasePath,
221 const wxString& newProjectName,
222 const wxString& srcFilePath,
223 wxString& aErrors )
224 {
225 // If a KIFACE owns files then it needs to implement this....
226 }
227
239 virtual void* IfaceOrAddress( int aDataId ) = 0;
240
244 virtual void GetActions( std::vector<TOOL_ACTION*>& aActions ) const = 0;
245
246 virtual int HandleJob( JOB* aJob, REPORTER* aReporter, PROGRESS_REPORTER* aProgressReporter )
247 {
248 return 0;
249 }
250
251 virtual bool HandleJobConfig( JOB* aJob, wxWindow* aParent )
252 {
253 return 0;
254 }
255};
256
257
285class KICOMMON_API KIWAY : public wxEvtHandler
286{
287 friend struct PGM_SINGLE_TOP; // can use set_kiface()
288
289public:
292 {
301
302 KIWAY_FACE_COUNT
303 };
304
305 ~KIWAY() throw () {}
306
313 static FACE_T KifaceType( FRAME_T aFrameType );
314
315 // If you change the vtable, recompile all of KiCad.
316
323 virtual KIFACE* KiFACE( FACE_T aFaceId, bool doLoad = true );
324
344 virtual KIWAY_PLAYER* Player( FRAME_T aFrameType, bool doCreate = true,
345 wxTopLevelWindow* aParent = nullptr );
346
355 virtual bool PlayerClose( FRAME_T aFrameType, bool doForce );
356
366 virtual bool PlayersClose( bool doForce );
367
371 void PlayerDidClose( FRAME_T aFrameType );
372
379 virtual void ExpressMail( FRAME_T aDestination, MAIL_T aCommand, std::string& aPayload,
380 wxWindow* aSource = nullptr );
381
385 virtual void GetActions( std::vector<TOOL_ACTION*>& aActions ) const;
386
393 virtual PROJECT& Prj() const;
394
398 virtual void SetLanguage( int aLanguage );
399
405 virtual void CommonSettingsChanged( int aFlags = 0 );
406
411 virtual void ProjectChanged();
412
413 KIWAY( int aCtlBits, wxFrame* aTop = nullptr );
414
419 void SetCtlBits( int aCtlBits ) { m_ctl = aCtlBits; }
420
427 void SetTop( wxFrame* aTop );
428 wxFrame* GetTop() { return m_top; }
429
430 void OnKiCadExit();
431
432 void OnKiwayEnd();
433
434 bool ProcessEvent( wxEvent& aEvent ) override;
435
436 int ProcessJob( KIWAY::FACE_T aFace, JOB* aJob, REPORTER* aReporter = nullptr,
437 PROGRESS_REPORTER* aProgressReporter = nullptr );
438 bool ProcessJobConfigDialog( KIWAY::FACE_T aFace, JOB* aJob, wxWindow* aWindow );
439
444 wxWindow* GetBlockingDialog();
445 void SetBlockingDialog( wxWindow* aWin );
446
447private:
449 const wxString dso_search_path( FACE_T aFaceId );
450
451 bool set_kiface( FACE_T aFaceType, KIFACE* aKiface )
452 {
453 if( (unsigned) aFaceType < (unsigned) KIWAY_FACE_COUNT )
454 {
455 m_kiface[aFaceType] = aKiface;
456 return true;
457 }
458
459 return false;
460 }
461
466 KIWAY_PLAYER* GetPlayerFrame( FRAME_T aFrameType );
467
468 static KIFACE* m_kiface[KIWAY_FACE_COUNT];
469 static int m_kiface_version[KIWAY_FACE_COUNT];
470
471 int m_ctl;
472
473 wxFrame* m_top; // Usually m_top is the Project manager
474
476
477 // An array to store the window ID of PLAYER frames which were run.
478 // A non empty name means only a PLAYER was run at least one time.
479 // Empty entries are represented by wxID_NONE.
480 // They can be closed, and the stored window ID may be invalid.
481 // Call: wxWindow::FindWindowById( m_playerFrameId[aFrameType] )
482 // to know if still exists (or GetPlayerFrame( FRAME_T aFrameType )
483 std::atomic<wxWindowID> m_playerFrameId[KIWAY_PLAYER_COUNT];
484};
485
486
487#ifndef SWIG
488// provided by single_top.cpp and kicad.cpp;
489extern KIWAY Kiway;
490// whereas python launchers: single_top.py and project manager instantiate as a python object
491#endif
492
493
506typedef KIFACE* KIFACE_GETTER_FUNC( int* aKIFACEversion, int aKIWAYversion, PGM_BASE* aProgram );
507
508
509#ifndef SWIG
510
512extern "C" {
513#if defined(BUILD_KIWAY_DLL)
514 KIFACE_API KIFACE* KIFACE_GETTER( int* aKIFACEversion, int aKIWAYversion, PGM_BASE* aProgram );
515#else
516 KIFACE* KIFACE_GETTER( int* aKIFACEversion, int aKIWAYversion, PGM_BASE* aProgram );
517#endif
518}
519
520#endif // SWIG
521
522#endif // KIWAY_H_
An simple container class that lets us dispatch output jobs to kifaces.
Definition: job.h:183
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
Definition: kiway_player.h:65
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition: kiway.h:286
void SetCtlBits(int aCtlBits)
Overwrites previously set ctl bits, only for use in kicad.cpp to flip between standalone and manager ...
Definition: kiway.h:419
wxWindowID m_blockingDialog
Definition: kiway.h:475
bool set_kiface(FACE_T aFaceType, KIFACE *aKiface)
Definition: kiway.h:451
wxFrame * m_top
Definition: kiway.h:473
wxFrame * GetTop()
Definition: kiway.h:428
FACE_T
Known KIFACE implementations.
Definition: kiway.h:292
@ FACE_SCH
eeschema DSO
Definition: kiway.h:293
@ FACE_PL_EDITOR
Definition: kiway.h:297
@ FACE_PYTHON
Definition: kiway.h:300
@ FACE_PCB
pcbnew DSO
Definition: kiway.h:294
@ FACE_CVPCB
Definition: kiway.h:295
@ FACE_GERBVIEW
Definition: kiway.h:296
@ FACE_BMP2CMP
Definition: kiway.h:299
@ FACE_PCB_CALCULATOR
Definition: kiway.h:298
~KIWAY()
Definition: kiway.h:305
int m_ctl
Definition: kiway.h:471
Container for data for KiCad programs.
Definition: pgm_base.h:103
A progress reporter interface for use in multi-threaded environments.
Container for project specific data.
Definition: project.h:65
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:73
Represent a single user action.
Definition: tool_action.h:304
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:65
#define KIFACE_API
Definition: import_export.h:61
PROJECT & Prj()
Definition: kicad.cpp:608
#define KICOMMON_API
Definition: kicommon.h:28
KIWAY Kiway
KIFACE * KIFACE_GETTER_FUNC(int *aKIFACEversion, int aKIWAYversion, PGM_BASE *aProgram)
Point to the one and only KIFACE export.
Definition: kiway.h:506
#define KIFACE_GETTER
Definition: kiway.h:110
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:153
virtual bool HandleJobConfig(JOB *aJob, wxWindow *aParent)
Definition: kiway.h:251
virtual wxWindow * CreateKiWindow(wxWindow *aParent, int aClassId, KIWAY *aKIWAY, int aCtlBits=0)=0
Create a wxWindow for the current project.
virtual bool OnKifaceStart(PGM_BASE *aProgram, int aCtlBits, KIWAY *aKiway)=0
Called just once shortly after the DSO is loaded.
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:218
virtual void Reset()=0
Reloads global state.
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, REPORTER *aReporter, PROGRESS_REPORTER *aProgressReporter)
Definition: kiway.h:246
virtual ~KIFACE()
Definition: kiway.h:158
Implement PGM_BASE with its own OnPgmInit() and OnPgmExit().
Definition: single_top.cpp:79