45#include <wx/stdpaths.h>
85void KIWAY::player_destroy_handler( wxWindowDestroyEvent& event )
98 m_top->Disconnect( wxEVT_DESTROY,
99 wxWindowDestroyEventHandler( KIWAY::player_destroy_handler ),
105 aTop->Connect( wxEVT_DESTROY,
106 wxWindowDestroyEventHandler( KIWAY::player_destroy_handler ),
131 wxASSERT_MSG( 0, wxT(
"caller has a bug, passed a bad aFaceId" ) );
132 return wxEmptyString;
142 path = wxStandardPaths::Get().GetExecutablePath();
145 wxFileName fn =
path;
149 fn.AppendDir( wxT(
"Contents" ) );
150 fn.AppendDir( wxT(
"PlugIns" ) );
158 if( wxGetEnv( wxT(
"KICAD_RUN_FROM_BUILD_DIR" ),
nullptr ) )
165 fn = wxStandardPaths::Get().GetExecutablePath();
171 fn.AppendDir( wxT(
"kicad" ) );
172 fn.AppendDir( wxT(
"kicad.app" ) );
173 fn.AppendDir( wxT(
"Contents" ) );
174 fn.AppendDir( wxT(
"PlugIns" ) );
184 default: dirName =
name + 1;
break;
188 fn.AppendDir( dirName );
194 fn.SetExt( &KIFACE_SUFFIX[1] );
196 return fn.GetFullPath();
215 wxASSERT_MSG( 0, wxT(
"caller has a bug, passed a bad aFaceId" ) );
229 if( wxGetEnv( wxT(
"KICAD_RUN_FROM_BUILD_DIR" ),
nullptr ) )
231 wxFileName myPath = wxStandardPaths::Get().GetExecutablePath();
233 if( !myPath.GetPath().EndsWith( wxT(
"pcbnew" ) ) )
235 myPath.RemoveLastDir();
236 myPath.AppendDir( wxT(
"pcbnew" ) );
243#ifdef KICAD_WIN32_VERIFY_CODESIGN
247 msg.Printf(
_(
"Failed to verify kiface library '%s' signature." ), dname );
252 wxDynamicLibrary dso;
254 void* addr =
nullptr;
260 int lc_new_type = LC_COLLATE;
261 std::string user_locale = setlocale( lc_new_type,
nullptr );
262 setlocale( lc_new_type,
"C" );
264 bool success = dso.Load( dname, wxDL_VERBATIM | wxDL_NOW | wxDL_GLOBAL );
266 setlocale( lc_new_type, user_locale.c_str() );
268 msg = wxString::Format(
"Loading kiface %d", aFaceId );
279 msg.Printf(
_(
"Failed to load kiface library '%s'." ), dname );
287 msg.Printf(
_(
"Could not read instance name and version from kiface library '%s'." ),
299 wxT(
"attempted DSO has a bug, failed to return a KIFACE*" ) );
301 wxDllType dsoHandle = dso.Detach();
303 bool startSuccess =
false;
330 dso.Attach( dsoHandle );
389 if( storedId == wxID_NONE )
392 wxWindow* frame = wxWindow::FindWindowById( storedId );
397 m_playerFrameId[aFrameType].compare_exchange_strong( storedId, wxID_NONE );
412 wxASSERT_MSG( 0, wxT(
"caller has a bug, passed a bad aFrameType" ) );
426 wxString msg = wxString::Format(
"Creating window type %d", aFrameType );
451 wxLogError(
_(
"Error loading editor." ) );
468 wxASSERT_MSG( 0, wxT(
"caller has a bug, passed a bad aFrameType" ) );
474 if( frame ==
nullptr )
477 wxString msg = wxString::Format(
"Closing window type %d", aFrameType );
508 wxWindow* aSource,
bool aFromOtherThread )
510 std::unique_ptr<KIWAY_EXPRESS> mail = std::make_unique<KIWAY_EXPRESS>( aDestination, aCommand, aPayload, aSource );
512 if( aFromOtherThread )
522 aActions.push_back( action );
543 for(
unsigned ii = 0;
LanguagesList[ii].m_KI_Lang_Identifier != 0; ii++ )
557 wxString::Format(
_(
"Unable to switch language to %s" ), lang ),
580 wxCommandEvent e( EDA_LANG_CHANGED );
593 wxCommandEvent e( EDA_LANG_CHANGED );
665 schface->ProjectChanged();
668 pcbface->ProjectChanged();
734 alive->GetEventHandler()->QueueEvent( aEvent );
744 return kiface->HandleJob( job, aReporter, aProgressReporter );
752 return kiface->HandleJobConfig( aJob, aWindow );
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
static std::list< TOOL_ACTION * > & GetActionList()
Return list of TOOL_ACTIONs.
The base frame for deriving all KiCad main window classes.
bool NonUserClose(bool aForce)
virtual void ProjectChanged()
Notification event that the project has changed.
void CommonSettingsChanged(int aFlags) override
Notification event that some of the common (suite-wide) settings have changed.
void ShowChangedLanguage() override
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.
virtual void ClearFileHistory()
Remove all files from the file history.
An simple container class that lets us dispatch output jobs to kifaces.
Carry a payload from one KIWAY_PLAYER to another within a PROJECT.
FRAME_T Dest()
Return the destination player id of the message.
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
virtual void KiwayMailIn(KIWAY_EXPRESS &aEvent)
Receive KIWAY_EXPRESS messages from other players.
bool ProcessJobConfigDialog(KIWAY::FACE_T aFace, JOB *aJob, wxWindow *aWindow)
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
const wxString dso_search_path(FACE_T aFaceId)
Get the [path &] name of the DSO holding the requested FACE_T.
int ProcessJob(KIWAY::FACE_T aFace, JOB *aJob, REPORTER *aReporter=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr)
void SetBlockingDialog(wxWindow *aWin)
LOCAL_HISTORY * m_local_history
virtual bool PlayerClose(FRAME_T aFrameType, bool doForce)
Call the KIWAY_PLAYER::Close( bool force ) function on the window and if not vetoed,...
static FACE_T KifaceType(FRAME_T aFrameType)
A simple mapping function which returns the FACE_T which is known to implement aFrameType.
wxWindowID m_blockingDialog
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr, bool aFromOtherThread=false)
Send aPayload to aDestination from aSource.
wxWindow * GetBlockingDialog()
Gets the window pointer to the blocking dialog (to send it signals)
void ClearFileHistory()
Clear the wxWidgets file history on each open frame.
static KIFACE * m_kiface[KIWAY_FACE_COUNT]
virtual void SetLanguage(int aLanguage)
Change the language and then calls ShowChangedLanguage() on all #KIWAY_PLAYERs.
virtual KIFACE * KiFACE(FACE_T aFaceId, bool doLoad=true)
Return the KIFACE* given a FACE_T.
FACE_T
Known KIFACE implementations.
static int m_kiface_version[KIWAY_FACE_COUNT]
KIWAY_PLAYER * GetPlayerFrame(FRAME_T aFrameType)
bool ProcessEvent(wxEvent &aEvent) override
virtual bool PlayersClose(bool doForce)
Call the KIWAY_PLAYER::Close( bool force ) function on all the windows and if none are vetoed,...
std::atomic< wxWindowID > m_playerFrameId[KIWAY_PLAYER_COUNT]
KIWAY(int aCtlBits, wxFrame *aTop=nullptr)
LOCAL_HISTORY & LocalHistory()
Return the LOCAL_HISTORY associated with this KIWAY.
virtual void CommonSettingsChanged(int aFlags=0)
Call CommonSettingsChanged() on all KIWAY_PLAYERs.
void QueueEvent(wxEvent *aEvent) override
void PlayerDidClose(FRAME_T aFrameType)
Notifies a Kiway that a player has been closed.
virtual void GetActions(std::vector< TOOL_ACTION * > &aActions) const
Append all registered actions to the given list.
void SetTop(wxFrame *aTop)
Tell this KIWAY about the top most frame in the program and optionally allows it to play the role of ...
virtual void ProjectChanged()
Calls ProjectChanged() on all KIWAY_PLAYERs.
virtual PROJECT & Prj() const
Return the PROJECT associated with this KIWAY.
Simple local history manager built on libgit2.
void ClearAllSavers()
Clear all registered savers.
virtual void SetLanguageIdentifier(int menu_id)
Set in .m_language_id member the wxWidgets language identifier ID from the KiCad menu id (internal me...
void HandleException(std::exception_ptr aPtr)
A exception handler to be used at the top level if exceptions bubble up that for.
virtual const wxString & GetExecutablePath() const
virtual SETTINGS_MANAGER & GetSettingsManager() const
virtual bool SetLanguage(wxString &aErrMsg, bool first_time=false)
Set the dictionary file name for internationalization.
A progress reporter interface for use in multi-threaded environments.
Container for project specific data.
A pure virtual class used to derive REPORTER objects from.
PROJECT & Prj() const
A helper while we are not MDI-capable – return the one and only project.
A logger class that filters out all log messages that are not generated by wxLogTrace and ignores the...
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
This file is part of the common library.
FRAME_T
The set of EDA_BASE_FRAME derivatives, typically stored in EDA_BASE_FRAME::m_Ident.
@ FRAME_SCH_SYMBOL_EDITOR
@ FRAME_FOOTPRINT_CHOOSER
#define THROW_IO_ERROR(msg)
macro which captures the "call site" values of FILE_, __FUNCTION & LINE
#define KFCTL_CPP_PROJECT_SUITE
Running under C++ project mgr, possibly with others.
KIFACE * KIFACE_GETTER_FUNC(int *aKIFACEversion, int aKIWAYversion, PGM_BASE *aProgram)
Point to the one and only KIFACE export.
#define KIFACE_INSTANCE_NAME_AND_VERSION
#define KIFACE_VERSION
The KIWAY and KIFACE classes are used to communicate between various process modules,...
#define KFCTL_STANDALONE
Running as a standalone Top.
This file contains miscellaneous commonly used macros and functions.
MAIL_T
The set of mail types sendable via KIWAY::ExpressMail() and supplied as the aCommand parameter to tha...
void AddNavigationBreadcrumb(const wxString &aMsg, const wxString &aCategory)
Add a navigation breadcrumb.
PGM_BASE & Pgm()
The global program "get" accessor.
LANGUAGE_DESCR LanguagesList[]
An array containing all the languages that KiCad supports.
Implement a participant in the KIWAY alchemy.
IFACE KIFACE_BASE kiface("pcb_test_frame", KIWAY::FACE_PCB)