Add Event Filtering Hooks To The App

Update the application and event-notifier plumbing to support event-type
filter registration and filtering at the wxApp level. This introduces a
callback-based filter registry in EventNotifier, exposes a new FilterEvent
override on CodeLiteApp, and wires the app through to the notifier so future
event interception can be centralized.

The app class declaration was also reorganized to place members and method
declarations under clearer access sections, and the bundled wxTerminalEmulator
submodule was advanced to a newer commit.

* Core event handling
* App lifecycle and class layout
* Submodule update

**Generated by CodeLite**

Signed-off-by: Eran Ifrah <eran@codelite.org>

Author: eranif

CodeLite/event_notifier.cpp

@@ -102,3 +102,42 @@ void EventNotifier::NotifyWorkspaceReloadStartEvet(const wxString& workspaceFile
 void EventNotifier::AddPendingEvent(const wxEvent& event) { wxEvtHandler::AddPendingEvent(event); }
 
 bool EventNotifier::ProcessEvent(wxEvent& event) { return wxEvtHandler::ProcessEvent(event); }
+
+EventFilterCallbackToken EventNotifier::AddEventTypeFilter(wxEventType type, EventFilterCallback callback)
+{
+    static EventFilterCallbackToken event_filter_id{0};
+    auto& callbacks = m_eventFilterCallbacks[type];
+    // Place it first
+    ++event_filter_id;
+    EventFilterCallbackContainer container{.id = event_filter_id, .callback = std::move(callback)};
+    callbacks.insert(callbacks.begin(), std::move(container));
+    return event_filter_id;
+}
+
+void EventNotifier::RemoveEventTypeFilter(wxEventType type, EventFilterCallbackToken token)
+{
+    auto iter = m_eventFilterCallbacks.find(type);
+    if (iter == m_eventFilterCallbacks.end()) {
+        return;
+    }
+
+    auto& v = iter->second;
+    size_t count = std::erase_if(v, [token](const EventFilterCallbackContainer& c) { return c.id == token; });
+    if (count && v.empty()) {
+        m_eventFilterCallbacks.erase(iter);
+    }
+}
+
+int EventNotifier::FilterEvent(wxEvent& event)
+{
+    if (m_eventFilterCallbacks.empty()) {
+        return wxEventFilter::Event_Skip;
+    }
+
+    auto iter = m_eventFilterCallbacks.find(event.GetEventType());
+    if (iter == m_eventFilterCallbacks.end()) {
+        return wxEventFilter::Event_Skip;
+    }
+
+    return wxEventFilter::Event_Skip;
+}

CodeLite/event_notifier.h

@@ -26,8 +26,11 @@
 #ifndef EVENTNOTIFIER_H
 #define EVENTNOTIFIER_H
 
+#include <functional>
 #include <future>
+#include <unordered_map>
 #include <wx/event.h>
+#include <wx/eventfilter.h>
 #include <wx/thread.h>
 
 #if wxUSE_GUI
@@ -36,12 +39,16 @@
 
 #include "codelite_exports.h"
 
+using EventFilterCallback = std::function<bool(wxEvent&)>;
+using EventFilterCallbackToken = size_t;
+
+struct WXDLLIMPEXP_CL EventFilterCallbackContainer {
+    EventFilterCallbackToken id{0};
+    EventFilterCallback callback;
+};
+
 class WXDLLIMPEXP_CL EventNotifier : public wxEvtHandler
 {
-private:
-    EventNotifier() = default;
-    virtual ~EventNotifier() = default;
-
 public:
     static EventNotifier* Get();
     static void Release();
@@ -115,6 +122,17 @@ class WXDLLIMPEXP_CL EventNotifier : public wxEvtHandler
         }
         return f.get();
     }
+
+    EventFilterCallbackToken AddEventTypeFilter(wxEventType type, EventFilterCallback callback);
+    void RemoveEventTypeFilter(wxEventType type, EventFilterCallbackToken token);
+
+    int FilterEvent(wxEvent& event);
+
+private:
+    EventNotifier() = default;
+    virtual ~EventNotifier() = default;
+
+    std::unordered_map<wxEventType, std::vector<EventFilterCallbackContainer>> m_eventFilterCallbacks;
 };
 
 #endif // EVENTNOTIFIER_H

LiteEditor/app.cpp

@@ -25,6 +25,7 @@
 
 #include "app.h"
 
+#include <algorithm>
 #ifdef __WXGTK__
 #include "exelocator.h"
 #endif
@@ -1183,3 +1184,7 @@ void CodeLiteApp::FinalizeShutdown()
     wxFileName::Rmdir(clStandardPaths::Get().GetTempDir(), wxPATH_RMDIR_RECURSIVE);
     clDEBUG() << "Finalizing shutdown...success" << endl;
 }
+
+int CodeLiteApp::FilterEvent(wxEvent& event) {
+    return EventNotifier::Get()->FilterEvent(event);
+}

LiteEditor/app.h

@@ -27,6 +27,7 @@
 #include "clPersistenceManager.h"
 #include "frame.h"
 
+#include <functional>
 #include <memory>
 #include <wx/cmdline.h>
 #include <wx/snglinst.h>
@@ -36,35 +37,6 @@ class CodeLiteApp : public wxApp
 public:
     enum PluginPolicy { PP_None = 0, PP_All, PP_FromList };
 
-protected:
-    clMainFrame* m_pMainFrame;
-    wxSingleInstanceChecker* m_singleInstance;
-    wxArrayString m_parserPaths;
-    wxLocale m_locale;
-    wxArrayString m_allowedPlugins;
-    PluginPolicy m_pluginLoadPolicy;
-    std::unique_ptr<clPersistenceManager> m_persistenceManager;
-    bool m_startedInDebuggerMode;
-
-    // When starting in debugger mode
-    wxString m_exeToDebug;
-    wxString m_debuggerArgs;
-    wxString m_debuggerWorkingDirectory;
-    static bool m_restartCodeLite;
-    static wxString m_restartCommand;
-    static wxString m_restartWD;
-    wxCmdLineParser m_parser;
-
-private: // Methods
-    bool CopySettings(const wxString& destDir, wxString& installPath);
-    bool IsSingleInstance(const wxCmdLineParser& parser);
-    void DoCopyGdbPrinters();
-    void MSWReadRegistry();
-    wxString DoFindMenuFile(const wxString& installDirectory);
-    void AdjustPathForCygwinIfNeeded();
-    void AdjustPathForMSYSIfNeeded();
-    void PrintUsage(const wxCmdLineParser& parser);
-
 public:
     CodeLiteApp();
     virtual ~CodeLiteApp();
@@ -104,11 +76,39 @@ class CodeLiteApp : public wxApp
 
     void ProcessCommandLineParams();
 
+private: // Methods
+    bool CopySettings(const wxString& destDir, wxString& installPath);
+    bool IsSingleInstance(const wxCmdLineParser& parser);
+    void DoCopyGdbPrinters();
+    void MSWReadRegistry();
+    wxString DoFindMenuFile(const wxString& installDirectory);
+    void AdjustPathForCygwinIfNeeded();
+    void AdjustPathForMSYSIfNeeded();
+    void PrintUsage(const wxCmdLineParser& parser);
+    int FilterEvent(wxEvent& event) override;
+
 protected:
-    virtual bool OnInit();
-    virtual int OnExit();
-    virtual void OnFatalException();
+    bool OnInit() override;
+    int OnExit() override;
+    void OnFatalException() override;
     void OpenFolder(const wxString& path);
     void OpenFile(const wxString& path, long lineNumber);
     void OpenItem(const wxString& path, long lineNumber);
+    clMainFrame* m_pMainFrame;
+    wxSingleInstanceChecker* m_singleInstance;
+    wxArrayString m_parserPaths;
+    wxLocale m_locale;
+    wxArrayString m_allowedPlugins;
+    PluginPolicy m_pluginLoadPolicy;
+    std::unique_ptr<clPersistenceManager> m_persistenceManager;
+    bool m_startedInDebuggerMode;
+
+    // When starting in debugger mode
+    wxString m_exeToDebug;
+    wxString m_debuggerArgs;
+    wxString m_debuggerWorkingDirectory;
+    static bool m_restartCodeLite;
+    static wxString m_restartCommand;
+    static wxString m_restartWD;
+    wxCmdLineParser m_parser;
 };