Add macro input variable support

CMakeLists.txt

@@ -120,6 +120,8 @@ target_sources(
           lib/macro/macro-export-import-dialog.hpp
           lib/macro/macro-helpers.cpp
           lib/macro/macro-helpers.hpp
+          lib/macro/macro-input.cpp
+          lib/macro/macro-input.hpp
           lib/macro/macro-list.cpp
           lib/macro/macro-list.hpp
           lib/macro/macro-properties.cpp

data/locale/en-US.ini

@@ -182,6 +182,10 @@ AdvSceneSwitcher.macroTab.segment.paste="Paste"
 AdvSceneSwitcher.macroTab.highlightSettings="Visual settings"
 AdvSceneSwitcher.macroTab.hotkeySettings="Hotkey settings"
 AdvSceneSwitcher.macroTab.generalSettings="General settings"
+AdvSceneSwitcher.macroTab.inputSettings="Input settings"
+AdvSceneSwitcher.macroTab.inputSettings.description="This section will allow you to specify variables, which will be treated as input parameters for the selected macro.\nWhen executing the macro using the \"Macro\" action type, you will have the option to set the values for those variables."
+AdvSceneSwitcher.macroTab.inputSettings.invalid="<Invalid selection>"
+AdvSceneSwitcher.macroTab.inputSettings.noInputs="No inputs defined!\nOpen macro settings to define inputs."
 AdvSceneSwitcher.macroTab.dockSettings="Dock settings"
 AdvSceneSwitcher.macroTab.highlightExecutedMacros="Highlight recently executed macros"
 AdvSceneSwitcher.macroTab.highlightTrueConditions="Highlight conditions of currently selected macro that evaluated to true recently"

lib/macro/macro-input.cpp

@@ -0,0 +1,247 @@
+#include "macro-input.hpp"
+#include "layout-helpers.hpp"
+#include "log-helper.hpp"
+#include "obs-module-helper.hpp"
+#include "variable-line-edit.hpp"
+
+#include <algorithm>
+#include <obs.hpp>
+
+namespace advss {
+
+void MacroInputVariables::Save(obs_data_t *obj) const
+{
+	OBSDataArrayAutoRelease array = obs_data_array_create();
+	for (auto &var : _inputVariables) {
+		OBSDataAutoRelease arrayObj = obs_data_create();
+		auto variable = var.lock();
+		if (variable) {
+			obs_data_set_string(arrayObj, "variableName",
+					    variable->Name().c_str());
+		} else {
+			obs_data_set_bool(arrayObj, "invalidVariable", true);
+		}
+		obs_data_array_push_back(array, arrayObj);
+	}
+	obs_data_set_array(obj, "inputVariables", array);
+}
+
+void MacroInputVariables::Load(obs_data_t *obj)
+{
+	OBSDataArrayAutoRelease array =
+		obs_data_get_array(obj, "inputVariables");
+	const size_t count = obs_data_array_count(array);
+	for (size_t i = 0; i < count; i++) {
+		OBSDataAutoRelease arrayObj = obs_data_array_item(array, i);
+		const bool isInvalid =
+			obs_data_get_bool(arrayObj, "invalidVariable");
+		if (isInvalid) {
+			_inputVariables.emplace_back();
+		} else {
+			const auto name =
+				obs_data_get_string(arrayObj, "variableName");
+			_inputVariables.emplace_back(
+				GetWeakVariableByName(name));
+		}
+	}
+}
+
+void MacroInputVariables::SetValues(const StringList &values)
+{
+	if (_inputVariables.size() != (size_t)values.size()) {
+#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+		blog(LOG_WARNING,
+		     "%s - sizes do not match (variables: %ld, values %d)",
+		     __func__, _inputVariables.size(), values.size());
+#else
+		blog(LOG_WARNING,
+		     "%s - sizes do not match (variables: %ld, values %lld)",
+		     __func__, _inputVariables.size(), values.size());
+#endif
+	}
+
+	for (size_t index = 0;
+	     index < _inputVariables.size() && index < (size_t)values.size();
+	     index++) {
+		auto variable = _inputVariables.at(index).lock();
+		if (!variable) {
+			continue;
+		}
+
+		variable->SetValue(values.at(index));
+	}
+}
+
+MacroInputSelection::MacroInputSelection(QWidget *parent) : ListEditor(parent)
+{
+	_list->setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Minimum);
+}
+
+void MacroInputSelection::SetInputs(const MacroInputVariables &inputs)
+{
+	_currentSelection = inputs;
+	for (const auto &var : inputs._inputVariables) {
+		auto variable = var.lock();
+		const auto name =
+			variable
+				? QString::fromStdString(variable->Name())
+				: obs_module_text(
+					  "AdvSceneSwitcher.macroTab.inputSettings.invalid");
+
+		QVariant v = QVariant::fromValue(name);
+		auto item = new QListWidgetItem(name, _list);
+		item->setData(Qt::UserRole, name);
+	}
+	UpdateListSize();
+}
+
+void MacroInputSelection::Add()
+{
+	std::string varName;
+	bool accepted = VariableSelectionDialog::AskForVariable(this, varName);
+
+	if (!accepted || varName.empty()) {
+		return;
+	}
+
+	_currentSelection._inputVariables.emplace_back(
+		GetWeakVariableByName(varName));
+
+	QVariant v = QVariant::fromValue(QString::fromStdString(varName));
+	auto item = new QListWidgetItem(QString::fromStdString(varName), _list);
+	item->setData(Qt::UserRole, QString::fromStdString(varName));
+	UpdateListSize();
+}
+
+void MacroInputSelection::Remove()
+{
+	auto item = _list->currentItem();
+	int idx = _list->currentRow();
+	if (!item || idx == -1) {
+		return;
+	}
+
+	_currentSelection._inputVariables.erase(
+		std::next(_currentSelection._inputVariables.begin(), idx));
+
+	delete item;
+	UpdateListSize();
+}
+
+void MacroInputSelection::Up()
+{
+	int idx = _list->currentRow();
+	if (idx < 1) {
+		return;
+	}
+
+	_list->insertItem(idx - 1, _list->takeItem(idx));
+	_list->setCurrentRow(idx - 1);
+
+	std::iter_swap(
+		std::next(_currentSelection._inputVariables.begin(), idx),
+		std::next(_currentSelection._inputVariables.begin(), idx - 1));
+}
+
+void MacroInputSelection::Down()
+{
+	int idx = _list->currentRow();
+	if (idx < 0 || idx >= _list->count()) {
+		return;
+	}
+
+	_list->insertItem(idx + 1, _list->takeItem(idx));
+	_list->setCurrentRow(idx + 1);
+
+	std::iter_swap(
+		std::next(_currentSelection._inputVariables.begin(), idx + 1),
+		std::next(_currentSelection._inputVariables.begin(), idx));
+}
+
+void MacroInputSelection::Clicked(QListWidgetItem *item)
+{
+	std::string varName;
+	bool accepted = VariableSelectionDialog::AskForVariable(this, varName);
+
+	if (!accepted || varName.empty()) {
+		return;
+	}
+
+	item->setText(QString::fromStdString(varName));
+	int idx = _list->currentRow();
+
+	_currentSelection._inputVariables.at(idx) =
+		GetWeakVariableByName(varName);
+}
+
+MacroInputEdit::MacroInputEdit(QWidget *parent)
+	: QWidget(parent),
+	  _layout(new QGridLayout())
+{
+	setLayout(_layout);
+}
+
+void MacroInputEdit::SetInputVariablesAndValues(
+	const MacroInputVariables &inputs, const StringList &values)
+{
+	_variables = inputs;
+	_values = values;
+	if ((size_t)_values.size() < _variables._inputVariables.size()) {
+#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
+		for (int i = 0;
+		     _variables._inputVariables.size() - (size_t)_values.size();
+		     i++) {
+			_values.push_back({});
+		}
+#else
+		_values.resize(_variables._inputVariables.size());
+#endif
+	}
+	SetupWidgets();
+}
+
+bool MacroInputEdit::HasInputsToSet() const
+{
+	return !_variables._inputVariables.empty();
+}
+
+void HighligthMacroSettingsButton(bool enable);
+
+void MacroInputEdit::SetupWidgets()
+{
+	ClearLayout(_layout);
+
+	auto &vars = _variables._inputVariables;
+	if (vars.empty()) {
+		_layout->addWidget(new QLabel(obs_module_text(
+			"AdvSceneSwitcher.macroTab.inputSettings.noInputs")));
+		adjustSize();
+		updateGeometry();
+		return;
+	}
+
+	for (size_t index = 0; index < vars.size(); index++) {
+		auto variable = vars.at(index).lock();
+		QLabel *label = new QLabel(
+			variable
+				? QString::fromStdString(variable->Name())
+				: obs_module_text(
+					  "AdvSceneSwitcher.macroTab.inputSettings.invalid"));
+		_layout->addWidget(label, index, 0);
+		auto valueEdit = new VariableLineEdit(this);
+		valueEdit->setEnabled(!!variable);
+		valueEdit->setText(_values.at(index));
+		connect(valueEdit, &VariableLineEdit::editingFinished,
+			[this, valueEdit, index]() {
+				_values[index] =
+					valueEdit->text().toStdString();
+				emit MacroInputValuesChanged(_values);
+			});
+		_layout->addWidget(valueEdit, index, 1);
+	}
+
+	adjustSize();
+	updateGeometry();
+}
+
+} // namespace advss

lib/macro/macro-input.hpp

@@ -0,0 +1,63 @@
+#pragma once
+#include "list-editor.hpp"
+#include "string-list.hpp"
+#include "variable.hpp"
+
+#include <QGridLayout>
+#include <memory>
+#include <vector>
+
+namespace advss {
+
+class MacroInputVariables {
+public:
+	void Save(obs_data_t *obj) const;
+	void Load(obs_data_t *obj);
+	void SetValues(const StringList &values);
+
+private:
+	std::vector<std::weak_ptr<Variable>> _inputVariables;
+	friend class MacroInputSelection;
+	friend class MacroInputEdit;
+};
+
+class MacroInputSelection final : public ListEditor {
+	Q_OBJECT
+
+public:
+	MacroInputSelection(QWidget *parent = nullptr);
+	void SetInputs(const MacroInputVariables &inputs);
+	MacroInputVariables GetInputs() const { return _currentSelection; }
+
+private slots:
+	void Add();
+	void Remove();
+	void Up();
+	void Down();
+	void Clicked(QListWidgetItem *);
+
+private:
+	MacroInputVariables _currentSelection;
+};
+
+class MacroInputEdit final : public QWidget {
+	Q_OBJECT
+
+public:
+	MacroInputEdit(QWidget *parent = nullptr);
+	void SetInputVariablesAndValues(const MacroInputVariables &inputs,
+					const StringList &values);
+	bool HasInputsToSet() const;
+
+signals:
+	void MacroInputValuesChanged(const StringList &);
+
+private:
+	void SetupWidgets();
+
+	MacroInputVariables _variables;
+	StringList _values;
+	QGridLayout *_layout;
+};
+
+} // namespace advss

lib/macro/macro-properties.cpp

@@ -56,6 +56,7 @@ MacroPropertiesDialog::MacroPropertiesDialog(QWidget *parent,
 		  "AdvSceneSwitcher.macroTab.currentSkipExecutionOnStartup"))),
 	  _currentStopActionsIfNotDone(new QCheckBox(obs_module_text(
 		  "AdvSceneSwitcher.macroTab.currentStopActionsIfNotDone"))),
+	  _currentInputs(new MacroInputSelection()),
 	  _currentMacroRegisterDock(new QCheckBox(obs_module_text(
 		  "AdvSceneSwitcher.macroTab.currentRegisterDock"))),
 	  _currentMacroDockAddRunButton(new QCheckBox(obs_module_text(
@@ -101,6 +102,16 @@ MacroPropertiesDialog::MacroPropertiesDialog(QWidget *parent,
 	generalLayout->addWidget(_currentStopActionsIfNotDone);
 	generalOptions->setLayout(generalLayout);
 
+	auto inputOptions = new QGroupBox(
+		obs_module_text("AdvSceneSwitcher.macroTab.inputSettings"));
+	auto description = new QLabel(obs_module_text(
+		"AdvSceneSwitcher.macroTab.inputSettings.description"));
+	description->setWordWrap(true);
+	auto inputLayout = new QVBoxLayout();
+	inputLayout->addWidget(description);
+	inputLayout->addWidget(_currentInputs);
+	inputOptions->setLayout(inputLayout);
+
 	int row = 0;
 	_dockLayout->addWidget(_currentMacroRegisterDock, row, 1, 1, 2);
 	row++;
@@ -174,6 +185,7 @@ MacroPropertiesDialog::MacroPropertiesDialog(QWidget *parent,
 	layout->addWidget(highlightOptions);
 	layout->addWidget(hotkeyOptions);
 	layout->addWidget(generalOptions);
+	layout->addWidget(inputOptions);
 	layout->addWidget(_dockOptions);
 	layout->setContentsMargins(0, 0, 0, 0);
 	scrollArea->setWidget(contentWidget);
@@ -191,6 +203,7 @@ MacroPropertiesDialog::MacroPropertiesDialog(QWidget *parent,
 	if (!macro || macro->IsGroup()) {
 		hotkeyOptions->hide();
 		generalOptions->hide();
+		inputOptions->hide();
 		_dockOptions->hide();
 		return;
 	}
@@ -198,6 +211,7 @@ MacroPropertiesDialog::MacroPropertiesDialog(QWidget *parent,
 	_currentMacroRegisterHotkeys->setChecked(macro->PauseHotkeysEnabled());
 	_currentSkipOnStartup->setChecked(macro->SkipExecOnStart());
 	_currentStopActionsIfNotDone->setChecked(macro->StopActionsIfNotDone());
+	_currentInputs->SetInputs(macro->GetInputVariables());
 	const bool dockEnabled = macro->DockEnabled();
 	_currentMacroRegisterDock->setChecked(dockEnabled);
 	_currentMacroDockAddRunButton->setChecked(macro->DockHasRunButton());
@@ -337,7 +351,7 @@ bool MacroPropertiesDialog::AskForSettings(QWidget *parent,
 		dialog._conditionsTrueStatusText->text().toStdString());
 	macro->SetConditionsFalseStatusText(
 		dialog._conditionsFalseStatusText->text().toStdString());
-
+	macro->SetInputVariables(dialog._currentInputs->GetInputs());
 	return true;
 }
 

lib/macro/macro-properties.hpp

@@ -1,5 +1,6 @@
 #pragma once
 #include "variable-line-edit.hpp"
+#include "macro-input.hpp"
 
 #include <QWidget>
 #include <QDialog>
@@ -50,6 +51,7 @@ private:
 	QCheckBox *_currentMacroRegisterHotkeys;
 	QCheckBox *_currentSkipOnStartup;
 	QCheckBox *_currentStopActionsIfNotDone;
+	MacroInputSelection *_currentInputs;
 	QCheckBox *_currentMacroRegisterDock;
 	QCheckBox *_currentMacroDockAddRunButton;
 	QCheckBox *_currentMacroDockAddPauseButton;

lib/macro/macro.cpp

@@ -348,6 +348,11 @@ void Macro::SetMatchOnChange(bool onChange)
 	_performActionsOnChange = onChange;
 }
 
+void Macro::SetStopActionsIfNotDone(bool stopActionsIfNotDone)
+{
+	_stopActionsIfNotDone = stopActionsIfNotDone;
+}
+
 void Macro::SetPaused(bool pause)
 {
 	if (_paused && !pause) {
@@ -382,6 +387,16 @@ void Macro::Stop()
 	}
 }
 
+MacroInputVariables Macro::GetInputVariables() const
+{
+	return _inputVariables;
+}
+
+void Macro::SetInputVariables(const MacroInputVariables &inputVariables)
+{
+	_inputVariables = inputVariables;
+}
+
 std::vector<TempVariable> Macro::GetTempVars(MacroSegment *filter) const
 {
 	std::vector<TempVariable> res;
@@ -610,6 +625,8 @@ bool Macro::Save(obs_data_t *obj) const
 	}
 	obs_data_set_array(obj, "elseActions", elseActions);
 
+	_inputVariables.Save(obj);
+
 	return true;
 }
 
@@ -748,6 +765,8 @@ bool Macro::Load(obs_data_t *obj)
 	}
 	UpdateElseActionIndices();
 
+	_inputVariables.Load(obj);
+
 	return true;
 }
 

lib/macro/macro.hpp

@@ -2,6 +2,7 @@
 #include "macro-action.hpp"
 #include "macro-condition.hpp"
 #include "macro-helpers.hpp"
+#include "macro-input.hpp"
 #include "macro-ref.hpp"
 #include "variable-string.hpp"
 #include "temp-variable.hpp"
@@ -25,35 +26,44 @@ public:
 	Macro(const std::string &name = "", const bool addHotkey = false);
 	virtual ~Macro();
 
-	bool CeckMatch();
-	bool PerformActions(bool match, bool forceParallel = false,
-			    bool ignorePause = false);
-	bool Matched() const { return _matched; }
-	bool ShouldRunActions() const;
-	int64_t MsSinceLastCheck() const;
 	std::string Name() const { return _name; }
 	void SetName(const std::string &name);
-	void SetRunInParallel(bool parallel) { _runInParallel = parallel; }
-	bool RunInParallel() const { return _runInParallel; }
+
+	bool CeckMatch();
+	bool Matched() const { return _matched; }
+	int64_t MsSinceLastCheck() const;
+	bool ShouldRunActions() const;
+	bool PerformActions(bool match, bool forceParallel = false,
+			    bool ignorePause = false);
+
 	void SetPaused(bool pause = true);
 	bool Paused() const { return _paused; }
 	bool WasPausedSince(
 		const std::chrono::high_resolution_clock::time_point &) const;
+
+	void Stop();
+	bool GetStop() const { return _stop; }
+	void ResetTimers();
+
 	void SetMatchOnChange(bool onChange);
 	bool MatchOnChange() const { return _performActionsOnChange; }
+
 	void SetSkipExecOnStart(bool skip) { _skipExecOnStart = skip; }
 	bool SkipExecOnStart() const { return _skipExecOnStart; }
-	void SetStopActionsIfNotDone(bool stopActionsIfNotDone)
-	{
-		_stopActionsIfNotDone = stopActionsIfNotDone;
-	}
+
+	void SetStopActionsIfNotDone(bool stopActionsIfNotDone);
 	bool StopActionsIfNotDone() const { return _stopActionsIfNotDone; }
+
 	int RunCount() const { return _runCount; };
 	void ResetRunCount() { _runCount = 0; };
-	void ResetTimers();
+
 	void AddHelperThread(std::thread &&);
-	bool GetStop() const { return _stop; }
-	void Stop();
+	void SetRunInParallel(bool parallel) { _runInParallel = parallel; }
+	bool RunInParallel() const { return _runInParallel; }
+
+	// Input variables
+	MacroInputVariables GetInputVariables() const;
+	void SetInputVariables(const MacroInputVariables &);
 
 	// Temporary variable helpers
 	std::vector<TempVariable> GetTempVars(MacroSegment *filter) const;
@@ -98,19 +108,21 @@ public:
 	bool SwitchesScene() const;
 
 	// UI helpers
-	const QList<int> &GetActionConditionSplitterPosition() const;
 	void SetActionConditionSplitterPosition(const QList<int>);
-	const QList<int> &GetElseActionSplitterPosition() const;
+	const QList<int> &GetActionConditionSplitterPosition() const;
 	void SetElseActionSplitterPosition(const QList<int>);
+	const QList<int> &GetElseActionSplitterPosition() const;
 	bool HasValidSplitterPositions() const;
 	bool WasExecutedSince(
 		const std::chrono::high_resolution_clock::time_point &) const;
 	bool OnChangePreventedActionsRecently();
 	void ResetUIHelpers();
 
+	// Hotkeys
 	void EnablePauseHotkeys(bool);
 	bool PauseHotkeysEnabled() const;
 
+	// Docks
 	void EnableDock(bool);
 	bool DockEnabled() const { return _registerDock; }
 	void SetDockHasRunButton(bool value);
@@ -182,6 +194,8 @@ private:
 	obs_hotkey_id _unpauseHotkey = OBS_INVALID_HOTKEY_ID;
 	obs_hotkey_id _togglePauseHotkey = OBS_INVALID_HOTKEY_ID;
 
+	MacroInputVariables _inputVariables;
+
 	// UI helpers
 	bool _onPreventedActionExecution = false;