Refactor + fixes

Author: messmerd

include/FloatModelEditorBase.h

@@ -44,7 +44,7 @@ class LMMS_EXPORT FloatModelEditorBase : public QWidget, public FloatModelView
 	void initUi(const QString & name); //!< to be called by ctors
 
 public:
-	enum class DirectionOfManipulation
+	enum class DirectionOfManipulation : bool
 	{
 		Vertical,
 		Horizontal
@@ -60,25 +60,34 @@ class LMMS_EXPORT FloatModelEditorBase : public QWidget, public FloatModelView
 		setUnit(txt_after);
 	}
 
-	//! In this mode, floating text is obtained by calling `pullFloatingText`.
-	void setFloatingTextPullMode()
+	//! Push model or pull model for floating text updates
+	enum class FloatingTextMode : bool
 	{
-		m_floatingTextPushMode = false;
-		m_floatingTextRefreshRate = 0;
-	}
+		//! Floating text is updated by this widget calling `pullFloatingText` as needed
+		Pull,
+
+		/**
+		 * Floating text is updated by an external component calling `pushFloatingText` when needed.
+		 *
+		 * This mode may optionally function in a hybrid fashion where this widget periodically emits
+		 * the `floatingTextUpdateRequested` signal for an external component to respond to by pushing
+		 * an update to `pushFloatingText`.
+		 */
+		Push
+	};
+
+	//! In this mode, floating text is updated by this widget calling `pullFloatingText` as needed
+	void setFloatingTextPullMode();
 
 	/**
-	 * In this mode, floating text must be set manually by calling `pushFloatingText`.
+	 * In this mode, floating text must be updated by an external component calling `pushFloatingText`.
 	 *
 	 * @param refreshRate How many times per second `floatingTextUpdateRequested` will be emitted
+	 *                    while the text float is visible
 	 */
-	void setFloatingTextPushMode(std::uint8_t refreshRate = 0)
-	{
-		m_floatingTextPushMode = true;
-		m_floatingTextRefreshRate = refreshRate;
-	}
+	void setFloatingTextPushMode(std::uint8_t refreshRate = 0);
 
-	//! Manually updates the text float's text
+	//! When using the push mode, external components must call this to update the text float's text
 	void pushFloatingText(const QString& text);
 
 signals:
@@ -87,8 +96,8 @@ class LMMS_EXPORT FloatModelEditorBase : public QWidget, public FloatModelView
 	void sliderMoved(float value);
 
 	/**
-	 * May be emitted periodically when the text float is visible.
-	 * Upon receiving this signal, call `pushFloatingText()` to update the
+	 * In push mode, may be emitted periodically when the text float is visible.
+	 * Upon receiving this signal, call `pushFloatingText` to update the
 	 * text float's text.
 	 */
 	void floatingTextUpdateRequested();
@@ -114,10 +123,11 @@ class LMMS_EXPORT FloatModelEditorBase : public QWidget, public FloatModelView
 
 	virtual float getValue(const QPoint & p);
 
-	//! Retreives floating text in a "pull" fashion
+	//! When using the pull mode, this method is periodically called to obtain the text float's text
 	virtual QString pullFloatingText() const;
 
-	void updateFloatingText();
+	//! Call before showing the text float
+	void takeControlOfTextFloat();
 
 	void doConnections() override;
 
@@ -137,13 +147,19 @@ class LMMS_EXPORT FloatModelEditorBase : public QWidget, public FloatModelView
 
 	DirectionOfManipulation m_directionOfManipulation;
 
-	bool m_floatingTextPushMode = false;
+	FloatingTextMode m_floatingTextMode = FloatingTextMode::Pull;
 	std::uint8_t m_floatingTextRefreshRate = 0; //! times per second
+	int m_textFloatRefreshTimerId = 0;
+
+private:
+	void timerEvent(QTimerEvent* event) override;
 
 private slots:
 	virtual void enterValue();
 	void friendlyUpdate();
 	void toggleScale();
+
+	void textFloatVisibilityChanged(bool visible);
 };
 
 } // namespace lmms::gui

include/SimpleTextFloat.h

@@ -26,8 +26,10 @@
 #ifndef LMMS_GUI_SIMPLE_TEXT_FLOAT_H
 #define LMMS_GUI_SIMPLE_TEXT_FLOAT_H
 
-#include <QTimer>
+
 #include <QWidget>
+#include <atomic>
+#include <mutex>
 
 #include "lmms_export.h"
 
@@ -60,25 +62,28 @@ class LMMS_EXPORT SimpleTextFloat : public QWidget
 	void show();
 	void hide();
 
-	void setRefreshRate(int timesPerSecond);
+	//! Stores which object is currently controlling the text float and disconnects the old source (if any)
+	void setSource(QObject* source);
 
-	template<class T>
-	void setRefreshConnection(T* receiver, void(T::* slot)(), Qt::ConnectionType type = Qt::AutoConnection)
-	{
-		if (auto connection = m_refreshTimer->callOnTimeout(receiver, slot,
-			static_cast<Qt::ConnectionType>(type | Qt::UniqueConnection)))
-		{
-			m_textUpdateConnection = connection;
-		}
-	}
+	//! Stores which object is currently controlling the text float and disconnects the old source (if any)
+	void setSource(QObject* source, QMetaObject::Connection connection);
+
+	//! @returns which object is currently controlling the text float
+	auto source() const -> QObject* { return m_source; }
+
+signals:
+	void visibilityChanged(bool visible);
 
 private:
 	QLabel * m_textLabel;
 	QTimer * m_showTimer;
 	QTimer * m_hideTimer;
-	QTimer* m_refreshTimer;
 
-	QMetaObject::Connection m_textUpdateConnection;
+	std::atomic<QObject*> m_source = nullptr;
+	QMetaObject::Connection m_connection;
+
+	// TODO: See if the mutex usage can be removed or reduced
+	std::recursive_mutex m_mutex;
 };
 
 } // namespace lmms::gui

plugins/Vestige/Vestige.cpp

@@ -982,7 +982,7 @@ ManageVestigeInstrumentView::ManageVestigeInstrumentView( Instrument * _instrume
 
 		auto knob = new Knob(KnobType::Bright26, description.left(15), SMALL_FONT_SIZE, this, description);
 		knob->setDescription(description + ":");
-		knob->setFloatingTextPushMode(10);
+		knob->setFloatingTextPushMode(15);
 		connect(knob, &Knob::floatingTextUpdateRequested, this, [i, this]() {
 			updateParameterText(i);
 		}, Qt::DirectConnection);

plugins/VstEffect/VstEffectControls.cpp

@@ -386,7 +386,7 @@ ManageVSTEffectView::ManageVSTEffectView( VstEffect * _eff, VstEffectControls *
 
 		auto knob = new Knob(KnobType::Bright26, description.left(15), SMALL_FONT_SIZE, widget, description);
 		knob->setDescription(description + ":");
-		knob->setFloatingTextPushMode(10);
+		knob->setFloatingTextPushMode(15);
 		connect(knob, &Knob::floatingTextUpdateRequested, this, [i, this]() {
 			updateParameterText(i);
 		}, Qt::DirectConnection);

src/common/RemotePluginBase.cpp

@@ -172,6 +172,7 @@ RemotePluginBase::message RemotePluginBase::waitForMessage(
 #ifndef BUILD_REMOTE_PLUGIN_CLIENT
 		if (_busy_waiting && !messagesLeft())
 		{
+			// FIXME: Can hang sometimes (due to too many messages?)
 			QCoreApplication::processEvents(
 				QEventLoop::ExcludeUserInputEvents, 50);
 			continue;

src/gui/widgets/Draggable.cpp

@@ -107,8 +107,9 @@ void Draggable::mouseMoveEvent(QMouseEvent* me)
 
 		emit sliderMoved(model()->value());
 		m_lastMousePos = pPos;
-		updateFloatingText();
-		s_textFloat->moveGlobal(this, QPoint(width() + 2, 0));
+
+		takeControlOfTextFloat();
+		s_textFloat->show();
 	}
 }
 

src/gui/widgets/FloatModelEditorBase.cpp

@@ -28,6 +28,7 @@
 #include <QApplication>
 #include <QInputDialog>
 #include <QPainter>
+#include <QTimerEvent>
 
 #include "lmms_math.h"
 #include "DeprecationHelper.h"
@@ -72,18 +73,37 @@ void FloatModelEditorBase::initUi(const QString & name)
 }
 
 
+void FloatModelEditorBase::setFloatingTextPullMode()
+{
+	m_floatingTextMode = FloatingTextMode::Pull;
+	m_floatingTextRefreshRate = 0;
+
+	killTimer(m_textFloatRefreshTimerId);
+	m_textFloatRefreshTimerId = 0;
+
+	disconnect(s_textFloat, &SimpleTextFloat::visibilityChanged,
+		this, &FloatModelEditorBase::textFloatVisibilityChanged);
+}
+
+
+void FloatModelEditorBase::setFloatingTextPushMode(std::uint8_t refreshRate)
+{
+	m_floatingTextMode = FloatingTextMode::Push;
+	m_floatingTextRefreshRate = refreshRate;
+}
+
+
 void FloatModelEditorBase::pushFloatingText(const QString& text)
 {
-	if (!m_floatingTextPushMode) { return; }
+	if (m_floatingTextMode == FloatingTextMode::Pull || s_textFloat->source() != this) { return; }
+
 	s_textFloat->setText(m_description.trimmed() + ' ' + text);
 }
 
 
 void FloatModelEditorBase::showTextFloat(int msecBeforeDisplay, int msecDisplayTime)
 {
-	updateFloatingText();
-	s_textFloat->moveGlobal(this, QPoint(width() + 2, 0));
-	s_textFloat->setRefreshRate(m_floatingTextRefreshRate);
+	takeControlOfTextFloat();
 	s_textFloat->showWithDelay(msecBeforeDisplay, msecDisplayTime);
 }
 
@@ -207,7 +227,7 @@ void FloatModelEditorBase::mouseMoveEvent(QMouseEvent * me)
 		m_lastMousePos = pos;
 	}
 
-	updateFloatingText();
+	takeControlOfTextFloat();
 	s_textFloat->show();
 }
 
@@ -342,6 +362,7 @@ void FloatModelEditorBase::wheelEvent(QWheelEvent * we)
 	const int inc = direction * stepMult;
 	model()->incValue(inc);
 
+	// NOTE: Calling timerEvent(nullptr) here can cause RemotePlugin to hang
 	showTextFloat(0, 1000);
 
 	emit sliderMoved(model()->value());
@@ -419,17 +440,52 @@ QString FloatModelEditorBase::pullFloatingText() const
 }
 
 
-void FloatModelEditorBase::updateFloatingText()
+void FloatModelEditorBase::takeControlOfTextFloat()
 {
-	if (!m_floatingTextPushMode)
+	if (m_floatingTextMode == FloatingTextMode::Pull)
 	{
+		s_textFloat->setSource(this);
 		s_textFloat->setText(m_description.trimmed() + ' ' + pullFloatingText());
 	}
-	else if (!s_textFloat->isVisible())
+	else if (m_floatingTextRefreshRate > 0)
 	{
-		s_textFloat->setText("");
-		s_textFloat->setRefreshConnection(this, &FloatModelEditorBase::floatingTextUpdateRequested);
+		const auto connection = connect(s_textFloat, &SimpleTextFloat::visibilityChanged,
+			this, &FloatModelEditorBase::textFloatVisibilityChanged,
+			static_cast<Qt::ConnectionType>(Qt::AutoConnection | Qt::UniqueConnection));
+
+		s_textFloat->setSource(this, connection);
 	}
+
+	s_textFloat->moveGlobal(this, QPoint(width() + 2, 0));
+}
+
+void FloatModelEditorBase::timerEvent(QTimerEvent* event)
+{
+	if (event && event->timerId() != m_textFloatRefreshTimerId) { return; }
+
+	// TODO: Thread check?
+
+	emit floatingTextUpdateRequested();
+}
+
+void FloatModelEditorBase::textFloatVisibilityChanged(bool visible)
+{
+	killTimer(m_textFloatRefreshTimerId);
+	if (visible)
+	{
+		if (m_floatingTextRefreshRate > 0)
+		{
+			// Emit timeout signal once at the very start so that the text is ready
+			// to be displayed when the text float becomes visible
+			timerEvent(nullptr);
+
+			// Now start timer normally
+			m_textFloatRefreshTimerId = startTimer(1000 / m_floatingTextRefreshRate);
+			return;
+		}
+	}
+
+	m_textFloatRefreshTimerId = 0;
 }