Add additional settings dialog to macro tab

This settings dialog currently contains debug features to highlight
recently executed macros, actions and conditions.

src/general.cpp

@@ -192,16 +192,6 @@ void AdvSceneSwitcher::on_uiHintsDisable_stateChanged(int state)
 	switcher->disableHints = state;
 }
 
-void AdvSceneSwitcher::on_highlightExecutedMacros_stateChanged(int state)
-{
-	if (loading) {
-		return;
-	}
-
-	switcher->highlightExecutedMacros = state;
-	emit HighlightMacrosChanged(switcher->highlightExecutedMacros);
-}
-
 bool isLegacyTab(const QString &name)
 {
 	return name == obs_module_text(
@@ -587,8 +577,6 @@ void SwitcherData::saveGeneralSettings(obs_data_t *obj)
 	obs_data_set_bool(obj, "showSystemTrayNotifications",
 			  showSystemTrayNotifications);
 	obs_data_set_bool(obj, "disableHints", disableHints);
-	obs_data_set_bool(obj, "highlightExecutedMacros",
-			  highlightExecutedMacros);
 	obs_data_set_bool(obj, "hideLegacyTabs", hideLegacyTabs);
 
 	obs_data_set_int(obj, "priority0", functionNamesByPriority[0]);
@@ -663,8 +651,6 @@ void SwitcherData::loadGeneralSettings(obs_data_t *obj)
 	showSystemTrayNotifications =
 		obs_data_get_bool(obj, "showSystemTrayNotifications");
 	disableHints = obs_data_get_bool(obj, "disableHints");
-	highlightExecutedMacros =
-		obs_data_get_bool(obj, "highlightExecutedMacros");
 	hideLegacyTabs = obs_data_get_bool(obj, "hideLegacyTabs");
 
 	obs_data_set_default_int(obj, "priority0", default_priority_0);
@@ -879,8 +865,6 @@ void AdvSceneSwitcher::setupGeneralTab()
 	ui->showTrayNotifications->setChecked(
 		switcher->showSystemTrayNotifications);
 	ui->uiHintsDisable->setChecked(switcher->disableHints);
-	ui->highlightExecutedMacros->setChecked(
-		switcher->highlightExecutedMacros);
 	ui->hideLegacyTabs->setChecked(switcher->hideLegacyTabs);
 
 	for (int p : switcher->functionNamesByPriority) {

src/headers/advanced-scene-switcher.hpp

@@ -93,6 +93,8 @@ signals:
 	void MacroRemoved(const QString &name);
 	void MacroRenamed(const QString &oldName, const QString newName);
 	void HighlightMacrosChanged(bool value);
+	void HighlightActionsChanged(bool value);
+	void HighlightConditionsChanged(bool value);
 	void SceneGroupAdded(const QString &name);
 	void SceneGroupRemoved(const QString &name);
 	void SceneGroupRenamed(const QString &oldName, const QString newName);
@@ -161,6 +163,7 @@ public slots:
 	void HighlightControls();
 	void MacroDragDropReorder(QModelIndex, int, int, QModelIndex, int);
 	void HighlightOnChange();
+	void on_macroProperties_clicked();
 
 	void on_screenRegionSwitches_currentRowChanged(int idx);
 	void on_showFrame_clicked();
@@ -191,7 +194,6 @@ public slots:
 	void on_saveWindowGeo_stateChanged(int state);
 	void on_showTrayNotifications_stateChanged(int state);
 	void on_uiHintsDisable_stateChanged(int state);
-	void on_highlightExecutedMacros_stateChanged(int state);
 	void on_hideLegacyTabs_stateChanged(int state);
 
 	void on_exportSettings_clicked();

src/headers/macro-properties.hpp

@@ -0,0 +1,29 @@
+#pragma once
+
+#include <QWidget>
+#include <QDialog>
+#include <QCheckBox>
+#include <obs-data.h>
+
+class MacroProperties {
+public:
+	void Save(obs_data_t *obj);
+	void Load(obs_data_t *obj);
+
+	bool _highlightExecuted = false;
+	bool _highlightConditions = false;
+	bool _highlightActions = false;
+};
+
+class MacroPropertiesDialog : public QDialog {
+	Q_OBJECT
+
+public:
+	MacroPropertiesDialog(QWidget *parent, const MacroProperties &);
+	static bool AskForSettings(QWidget *parent, MacroProperties &userInput);
+
+private:
+	QCheckBox *_executed;
+	QCheckBox *_conditions;
+	QCheckBox *_actions;
+};

src/headers/switcher-data-structs.hpp

@@ -26,6 +26,7 @@
 #include "switch-network.hpp"
 
 #include "macro.hpp"
+#include "macro-properties.hpp"
 #include "duration-control.hpp"
 
 constexpr auto default_interval = 300;
@@ -88,7 +89,6 @@ struct SwitcherData {
 	bool verbose = false;
 	bool disableHints = false;
 	bool hideLegacyTabs = false;
-	bool highlightExecutedMacros = false;
 	bool showSystemTrayNotifications = false;
 	bool showFrame = false;
 	bool transitionOverrideOverride = false;
@@ -121,6 +121,7 @@ struct SwitcherData {
 	Duration cooldown;
 	std::chrono::high_resolution_clock::time_point lastMatchTime;
 
+	MacroProperties macroProperties;
 	std::deque<std::shared_ptr<Macro>> macros;
 	std::condition_variable macroWaitCv;
 	std::atomic_bool abortMacroWait = {false};

src/macro-action-edit.cpp

@@ -63,7 +63,7 @@ static inline void populateActionSelection(QComboBox *list)
 MacroActionEdit::MacroActionEdit(QWidget *parent,
 				 std::shared_ptr<MacroAction> *entryData,
 				 const std::string &id)
-	: MacroSegmentEdit(switcher->highlightExecutedMacros, parent),
+	: MacroSegmentEdit(switcher->macroProperties._highlightActions, parent),
 	  _entryData(entryData)
 {
 	_actionSelection = new QComboBox();
@@ -71,6 +71,8 @@ MacroActionEdit::MacroActionEdit(QWidget *parent,
 	QWidget::connect(_actionSelection,
 			 SIGNAL(currentTextChanged(const QString &)), this,
 			 SLOT(ActionSelectionChanged(const QString &)));
+	QWidget::connect(window(), SIGNAL(HighlightActionsChanged(bool)), this,
+			 SLOT(EnableHighlight(bool)));
 
 	populateActionSelection(_actionSelection);
 

src/macro-condition-edit.cpp

@@ -92,7 +92,8 @@ static inline void populateConditionSelection(QComboBox *list)
 MacroConditionEdit::MacroConditionEdit(
 	QWidget *parent, std::shared_ptr<MacroCondition> *entryData,
 	const std::string &id, bool root)
-	: MacroSegmentEdit(switcher->highlightExecutedMacros, parent),
+	: MacroSegmentEdit(switcher->macroProperties._highlightConditions,
+			   parent),
 	  _entryData(entryData),
 	  _isRoot(root)
 {
@@ -112,6 +113,8 @@ MacroConditionEdit::MacroConditionEdit(
 	QWidget::connect(_dur, SIGNAL(ConditionChanged(DurationCondition)),
 			 this,
 			 SLOT(DurationConditionChanged(DurationCondition)));
+	QWidget::connect(window(), SIGNAL(HighlightConditionsChanged(bool)),
+			 this, SLOT(EnableHighlight(bool)));
 
 	populateLogicSelection(_logicSelection, root);
 	populateConditionSelection(_conditionSelection);

src/macro-properties.cpp

@@ -0,0 +1,79 @@
+#include "headers/macro-properties.hpp"
+
+#include <QVBoxLayout>
+#include <QDialogButtonBox>
+#include <obs-module.h>
+
+void MacroProperties::Save(obs_data_t *obj)
+{
+	auto data = obs_data_create();
+	obs_data_set_bool(data, "highlightExecuted", _highlightExecuted);
+	obs_data_set_bool(data, "highlightConditions", _highlightConditions);
+	obs_data_set_bool(data, "highlightActions", _highlightActions);
+	obs_data_set_obj(obj, "macroProperties", data);
+	obs_data_release(data);
+}
+
+void MacroProperties::Load(obs_data_t *obj)
+{
+	auto data = obs_data_get_obj(obj, "macroProperties");
+	// TODO: Remove in future version
+	if (obs_data_has_user_value(obj, "highlightExecutedMacros")) {
+		_highlightExecuted =
+			obs_data_get_bool(obj, "highlightExecutedMacros");
+	} else {
+		_highlightExecuted =
+			obs_data_get_bool(data, "highlightExecuted");
+	}
+	_highlightConditions = obs_data_get_bool(data, "highlightConditions");
+	_highlightActions = obs_data_get_bool(data, "highlightActions");
+	obs_data_release(data);
+}
+
+MacroPropertiesDialog::MacroPropertiesDialog(QWidget *parent,
+					     const MacroProperties &prop)
+	: QDialog(parent),
+	  _executed(new QCheckBox(obs_module_text(
+		  "AdvSceneSwitcher.macroTab.highlightExecutedMacros"))),
+	  _conditions(new QCheckBox(obs_module_text(
+		  "AdvSceneSwitcher.macroTab.highlightTrueConditions"))),
+	  _actions(new QCheckBox(obs_module_text(
+		  "AdvSceneSwitcher.macroTab.highlightPerformedActions")))
+{
+	setModal(true);
+	setWindowModality(Qt::WindowModality::WindowModal);
+	setWindowFlags(windowFlags() & ~Qt::WindowContextHelpButtonHint);
+	setFixedWidth(555);
+	setMinimumHeight(100);
+
+	_executed->setChecked(prop._highlightExecuted);
+	_conditions->setChecked(prop._highlightConditions);
+	_actions->setChecked(prop._highlightActions);
+
+	QVBoxLayout *layout = new QVBoxLayout;
+	layout->addWidget(_executed);
+	layout->addWidget(_conditions);
+	layout->addWidget(_actions);
+	setLayout(layout);
+
+	QDialogButtonBox *buttonbox = new QDialogButtonBox(
+		QDialogButtonBox::Ok | QDialogButtonBox::Cancel);
+	layout->addWidget(buttonbox);
+	buttonbox->setCenterButtons(true);
+	connect(buttonbox, &QDialogButtonBox::accepted, this, &QDialog::accept);
+	connect(buttonbox, &QDialogButtonBox::rejected, this, &QDialog::reject);
+}
+
+bool MacroPropertiesDialog::AskForSettings(QWidget *parent,
+					   MacroProperties &userInput)
+{
+	MacroPropertiesDialog dialog(parent, userInput);
+	dialog.setWindowTitle(obs_module_text("AdvSceneSwitcher.windowTitle"));
+	if (dialog.exec() != DialogCode::Accepted) {
+		return false;
+	}
+	userInput._highlightExecuted = dialog._executed->isChecked();
+	userInput._highlightConditions = dialog._conditions->isChecked();
+	userInput._highlightActions = dialog._actions->isChecked();
+	return true;
+}

src/macro-segment.cpp

@@ -98,9 +98,6 @@ MacroSegmentEdit::MacroSegmentEdit(bool highlight, QWidget *parent)
 		SIGNAL(SceneGroupRenamed(const QString &, const QString)), this,
 		SIGNAL(SceneGroupRenamed(const QString &, const QString)));
 
-	QWidget::connect(parent, SIGNAL(HighlightMacrosChanged(bool)), this,
-			 SLOT(EnableHighlight(bool)));
-
 	_timer.setInterval(1500);
 	connect(&_timer, SIGNAL(timeout()), this, SLOT(Highlight()));
 	_timer.start();

src/macro-tab.cpp

@@ -4,6 +4,7 @@
 #include "headers/macro-condition-edit.hpp"
 #include "headers/advanced-scene-switcher.hpp"
 #include "headers/name-dialog.hpp"
+#include "headers/macro-properties.hpp"
 #include "headers/utility.hpp"
 
 #include <QColor>
@@ -68,7 +69,7 @@ QListWidgetItem *AddNewMacroListEntry(QListWidget *list,
 	QListWidgetItem *item = new QListWidgetItem(list);
 	item->setData(Qt::UserRole, QString::fromStdString(macro->Name()));
 	auto listEntry = new MacroListEntryWidget(
-		macro, switcher->highlightExecutedMacros, list);
+		macro, switcher->macroProperties._highlightExecuted, list);
 	item->setSizeHint(listEntry->minimumSizeHint());
 	list->setItemWidget(item, listEntry);
 	return item;
@@ -416,13 +417,26 @@ void AdvSceneSwitcher::HighlightOnChange()
 		return;
 	}
 
-	if (switcher->highlightExecutedMacros &&
+	if (switcher->macroProperties._highlightExecuted &&
 	    macro->OnChangePreventedActionsRecently()) {
 		PulseWidget(ui->runMacroOnChange, Qt::yellow, Qt::transparent,
 			    true);
 	}
 }
 
+void AdvSceneSwitcher::on_macroProperties_clicked()
+{
+	MacroProperties prop = switcher->macroProperties;
+	bool accepted = MacroPropertiesDialog::AskForSettings(this, prop);
+	if (!accepted) {
+		return;
+	}
+	switcher->macroProperties = prop;
+	emit HighlightMacrosChanged(prop._highlightExecuted);
+	emit HighlightActionsChanged(prop._highlightActions);
+	emit HighlightConditionsChanged(prop._highlightConditions);
+}
+
 void AdvSceneSwitcher::setupMacroTab()
 {
 	const QSignalBlocker signalBlocker(ui->macros);

src/macro.cpp

@@ -600,6 +600,8 @@ void MacroAction::LogAction()
 
 void SwitcherData::saveMacros(obs_data_t *obj)
 {
+	switcher->macroProperties.Save(obj);
+
 	obs_data_array_t *macroArray = obs_data_array_create();
 	for (auto &m : macros) {
 		obs_data_t *array_obj = obs_data_create();
@@ -615,8 +617,9 @@ void SwitcherData::saveMacros(obs_data_t *obj)
 
 void SwitcherData::loadMacros(obs_data_t *obj)
 {
-	macros.clear();
+	switcher->macroProperties.Load(obj);
 
+	macros.clear();
 	obs_data_array_t *macroArray = obs_data_get_array(obj, "macros");
 	size_t count = obs_data_array_count(macroArray);