Rewrite tooltip manager to avoid leaking connections

Author: filip-hejsek

src/meson.build

@@ -135,7 +135,7 @@ aegisub_src = files(
     'timeedit_ctrl.cpp',
     'toggle_bitmap.cpp',
     'toolbar.cpp',
-    'tooltip_manager.cpp',
+    'tooltip_binding.cpp',
     'utils.cpp',
     'validators.cpp',
     'vector2d.cpp',

src/subs_edit_box.cpp

@@ -51,7 +51,6 @@
 #include "subs_edit_ctrl.h"
 #include "text_selection_controller.h"
 #include "timeedit_ctrl.h"
-#include "tooltip_manager.h"
 #include "validators.h"
 
 #include <libaegisub/character_count.h>
@@ -282,7 +281,7 @@ TimeEdit *SubsEditBox::MakeTimeCtrl(wxString const& tooltip, TimeField field) {
 void SubsEditBox::MakeButton(const char *cmd_name) {
 	cmd::Command *command = cmd::get(cmd_name);
 	wxBitmapButton *btn = new wxBitmapButton(this, -1, command->Icon());
-	ToolTipManager::Bind(btn, command->StrHelp(), "Subtitle Edit Box", cmd_name);
+	tool_tip_bindings.emplace_back(btn, command->StrHelp(), "Subtitle Edit Box", cmd_name);
 
 	middle_right_sizer->Add(btn, wxSizerFlags().Expand());
 	btn->Bind(wxEVT_BUTTON, std::bind(&SubsEditBox::CallCommand, this, cmd_name));
@@ -291,7 +290,7 @@ void SubsEditBox::MakeButton(const char *cmd_name) {
 wxButton *SubsEditBox::MakeBottomButton(const char *cmd_name) {
 	cmd::Command *command = cmd::get(cmd_name);
 	wxButton *btn = new wxButton(this, -1, command->StrDisplay(c));
-	ToolTipManager::Bind(btn, command->StrHelp(), "Subtitle Edit Box", cmd_name);
+	tool_tip_bindings.emplace_back(btn, command->StrHelp(), "Subtitle Edit Box", cmd_name);
 
 	btn->Bind(wxEVT_BUTTON, std::bind(&SubsEditBox::CallCommand, this, cmd_name));
 	return btn;

src/subs_edit_box.h

@@ -27,9 +27,12 @@
 //
 // Aegisub Project http://www.aegisub.org/
 
+#include "tooltip_binding.h"
+
 #include <array>
 #include <boost/container/map.hpp>
 #include <boost/flyweight/flyweight_fwd.hpp>
+#include <list>
 #include <vector>
 
 #include <wx/combobox.h>
@@ -68,6 +71,7 @@ class SubsEditBox final : public wxPanel {
 	};
 
 	std::vector<agi::signal::Connection> connections;
+	std::list<ToolTipBinding> tool_tip_bindings;
 
 	/// Currently active dialogue line
 	AssDialogue *line = nullptr;

src/toggle_bitmap.cpp

@@ -35,7 +35,6 @@
 #include "toggle_bitmap.h"
 
 #include "command/command.h"
-#include "tooltip_manager.h"
 
 #include <wx/dcbuffer.h>
 #include <wx/settings.h>
@@ -46,6 +45,7 @@ ToggleBitmap::ToggleBitmap(wxWindow *parent, agi::Context *context, const char *
 , context(context)
 , command(*cmd::get(cmd_name))
 , imgs(command.Icon(icon_size))
+, tool_tip_binding(this, command.StrHelp(), ht_ctx, cmd_name)
 {
 	wxBitmap img = imgs.GetBitmapFor(this);
 	int w = size.GetWidth() != -1 ? size.GetWidth() : img.GetLogicalWidth();
@@ -55,7 +55,6 @@ ToggleBitmap::ToggleBitmap(wxWindow *parent, agi::Context *context, const char *
 	SetSizeHints(w, h, w, h);
 	SetBackgroundStyle(wxBG_STYLE_PAINT);
 
-	ToolTipManager::Bind(this, command.StrHelp(), ht_ctx, cmd_name);
 	Bind(wxEVT_PAINT, &ToggleBitmap::OnPaint, this);
 	Bind(wxEVT_LEFT_DOWN, &ToggleBitmap::OnMouseEvent, this);
 }

src/toggle_bitmap.h

@@ -32,6 +32,8 @@
 /// @ingroup custom_control
 ///
 
+#include "tooltip_binding.h"
+
 #include <wx/bmpbndl.h>
 #include <wx/control.h>
 
@@ -42,6 +44,7 @@ class ToggleBitmap final : public wxControl {
 	agi::Context *context;
 	cmd::Command &command;
 	wxBitmapBundle imgs;
+	ToolTipBinding tool_tip_binding;
 
 	void OnMouseEvent(wxMouseEvent &evt);
 	void OnPaint(wxPaintEvent &evt);

src/tooltip_manager.cpp src/tooltip_binding.cppsrc/tooltip_manager.cpp renamed to src/tooltip_binding.cpp

@@ -27,38 +27,23 @@
 //
 // Aegisub Project http://www.aegisub.org/
 
-/// @file tooltip_manager.cpp
+/// @file tooltip_binding.cpp
 /// @brief Generate tooltips for controls by combining a base text and any hotkeys found for the function
 /// @ingroup custom_control
 ///
 
-#include "tooltip_manager.h"
+#include "tooltip_binding.h"
 
 #include "compat.h"
 #include "include/aegisub/hotkey.h"
 
 #include <libaegisub/hotkey.h>
 
-#include <list>
-#include <wx/weakref.h>
-#include <wx/window.h>
-
-struct ToolTipBinding {
-	wxWeakRef<wxWindow> window;
-	wxString toolTip;
-	const char *command;
-	const char *context;
-	void Update();
-};
-
-void ToolTipManager::Bind(wxWindow *window, wxString tooltip, const char *context, const char *command) {
-	ToolTipBinding tip{window, tooltip, command, context};
-	tip.Update();
-
-	static std::list<ToolTipBinding> tips;
-	tips.push_back(tip);
-	// FIXME: lifetime of the connection?
-	hotkey::inst->AddHotkeyChangeListener(&ToolTipBinding::Update, &tips.back());
+ToolTipBinding::ToolTipBinding(wxWindow *window, wxString tooltip, const char *context, const char *command)
+: window(window), toolTip(tooltip), context(context), command(command)
+, connection(hotkey::inst->AddHotkeyChangeListener(&ToolTipBinding::Update, this))
+{
+	Update();
 }
 
 void ToolTipBinding::Update() {

src/tooltip_manager.h src/tooltip_binding.hsrc/tooltip_manager.h renamed to src/tooltip_binding.h

@@ -27,10 +27,29 @@
 //
 // Aegisub Project http://www.aegisub.org/
 
-class wxString;
-class wxWindow;
+#pragma once
+
+#include <libaegisub/signal.h>
+
+#include <wx/weakref.h>
+#include <wx/window.h>
+
+class ToolTipBinding {
+private:
+	wxWeakRef<wxWindow> window;
+	wxString toolTip;
+	const char *context;
+	const char *command;
+	agi::signal::Connection connection;
+
+	void Update();
 
-class ToolTipManager {
 public:
-	static void Bind(wxWindow *window, wxString tooltip, const char *context, const char *command);
+	ToolTipBinding(wxWindow *window, wxString tooltip, const char *context, const char *command);
+
+	ToolTipBinding(const ToolTipBinding&) = delete;
+	ToolTipBinding& operator=(const ToolTipBinding&) = delete;
+
+	ToolTipBinding(ToolTipBinding&&) = delete;
+	ToolTipBinding& operator=(ToolTipBinding&&) = delete;
 };