[Bug]: Assertion failure in SearchDynamicEventTable() when closing Preferences

[mimosius]

What happened?

ASSERT INFO:
./src/common/event.cpp(1981): assert "nNew != dynamicEvents.size()" failed in SearchDynamicEventTable().

BACKTRACE:
[1] wxEvtHandler::SearchDynamicEventTable(wxEvent&)
[2] wxEvtHandler::TryHereOnly(wxEvent&)
[3] wxEvtHandler::ProcessEventLocally(wxEvent&)
[4] wxEvtHandler::ProcessEvent(wxEvent&)
[5] wxEvtHandler::SafelyProcessEvent(wxEvent&)
[6] wxEvtHandler::ProcessPendingEvents()
[7] wxApp::DoIdle()
[8] g_main_loop_run
[9] gtk_main
[10] wxGUIEventLoop::DoRun()
[11] wxEventLoopBase::Run()
[12] wxAppConsoleBase::MainLoop()
[13] wxEntry(int&, wchar_t**)
[14] __libc_start_main

Version

Self compiled

18.2.0+git171.gd589b09e6

wxWidgets Library (wxGTK port)
Version 3.2.8 (Unicode: wchar_t, debug level: 1),
Runtime version of toolkit used is 3.24.51.
Compile-time GTK+ version is 3.24.50.

Operating system

Linux

Steps to reproduce

Open a workspace and a file from within, navigate to Settings -> Preferences, and click OK.

Notes:

The issue is reproducible on wx 3.2.8.x but is not present in wx 3.3-devel.

It looks like a dynamic event binding isssue.

[eranif]

This backtrace is purely wxWidgets, i.e. to CodeLite code. Can you provide something more meaningful than this?

[mimosius]

Assertion failure triggered by wxEVT_EDITOR_CONFIG_CHANGED.

Details:

• The event is added to the queue as a pending event.

• Reproduced by: Clicking the OK button to close the preferences dialog.

• Not reproducible by: Clicking the Apply button.

[mimosius]

Experimented with immediate event processing vs. queuing of wxEVT_EDITOR_CONFIG_CHANGED. It doesn't cause the assertion failure, but I'm not familiar enough with the code to identify potential side effects.

[mimosius]

Tested CodeLite up to 18.2.0+git267.g6b5948483 against wx3.2.8.x and current wx-git since bug report using this patch

diff --git a/LiteEditor/options_dlg2.cpp b/LiteEditor/options_dlg2.cpp
index 8185e5bc3..4755cf8a9 100644
--- a/LiteEditor/options_dlg2.cpp
+++ b/LiteEditor/options_dlg2.cpp
@@ -73,7 +73,8 @@ void PreferencesDialog::DoSave()
     EditorConfigST::Get()->Save();
 
     // Notify plugins about settings changed
-    PostCmdEvent(wxEVT_EDITOR_SETTINGS_CHANGED);
+    wxCommandEvent event(wxEVT_EDITOR_CONFIG_CHANGED);
+    EventNotifier::Get()->ProcessEvent(event);
 }
 
 void PreferencesDialog::Initialize()
diff --git a/Plugin/editor_config.cpp b/Plugin/editor_config.cpp
index f6381b393..902871478 100644
--- a/Plugin/editor_config.cpp
+++ b/Plugin/editor_config.cpp
@@ -177,7 +177,7 @@ void EditorConfig::SetOptions(OptionsConfigPtr opts)
     DoSave();
     wxCommandEvent evt(wxEVT_EDITOR_CONFIG_CHANGED);
     evt.SetString(nodeName);
-    EventNotifier::Get()->AddPendingEvent(evt);
+    EventNotifier::Get()->ProcessEvent(evt);
 }
 
 int clSortStringsFunc(const wxString& first, const wxString& second)
@@ -248,7 +248,7 @@ void EditorConfig::SetRecentItems(const wxArrayString& files, const wxString& no
     DoSave();
     wxCommandEvent evt(wxEVT_EDITOR_CONFIG_CHANGED);
     evt.SetString(nodeName);
-    EventNotifier::Get()->AddPendingEvent(evt);
+    EventNotifier::Get()->ProcessEvent(evt);
 }
 
 bool EditorConfig::WriteObject(const wxString& name, SerializedObject* obj)
@@ -260,7 +260,7 @@ bool EditorConfig::WriteObject(const wxString& name, SerializedObject* obj)
     bool res = DoSave();
     wxCommandEvent evt(wxEVT_EDITOR_CONFIG_CHANGED);
     evt.SetString(name);
-    EventNotifier::Get()->AddPendingEvent(evt);
+    EventNotifier::Get()->ProcessEvent(evt);
     return res;
 }
 
@@ -336,7 +336,7 @@ bool EditorConfig::DoSave() const
 
     // Notify that the editor configuration was modified
     wxCommandEvent event(wxEVT_EDITOR_CONFIG_CHANGED);
-    EventNotifier::Get()->AddPendingEvent(event);
+    EventNotifier::Get()->ProcessEvent(event);
     return XmlUtils::SaveXmlToFile(m_doc, m_fileName.GetFullPath());
 }

There are no more failed assertions in this case on wx3.2.8.x (Clicking Ok) - and as a side effect, flickering of sidebars is gone with this patch while clicking 'Ok' or 'Apply' .

Anyway, clicking Apply or OK witiin the Preferences dialog is causing a hell storm of wxEVT_EDITOR_CONFIG_CHANGED events.