Add log level which prints performed actions

WarmUpTill · Mar 2, 2024 · 5cb48cb · 5cb48cb
1 parent e9ea2e8
commit 5cb48cb
Show file tree

Hide file tree

Showing 56 changed files with 138 additions and 94 deletions.
diff --git a/data/locale/en-US.ini b/data/locale/en-US.ini
@@ -26,6 +26,10 @@ AdvSceneSwitcher.generalTab.generalBehavior.onNoMet.switchToRandom="Switch to an
 AdvSceneSwitcher.generalTab.generalBehavior.onNoMet.switchTo="Switch to:"
 AdvSceneSwitcher.generalTab.generalBehavior.cooldown="After performing actions skip performing actions for"
 AdvSceneSwitcher.generalTab.generalBehavior.cooldownHint="During this time potential matches will be ignored!"
+AdvSceneSwitcher.generalTab.generalBehavior.logLevel="Log level:"
+AdvSceneSwitcher.generalTab.generalBehavior.logLevel.default="Default"
+AdvSceneSwitcher.generalTab.generalBehavior.logLevel.printActions="Log performed actions"
+AdvSceneSwitcher.generalTab.generalBehavior.logLevel.verbose="Verbose logging"
 AdvSceneSwitcher.generalTab.generalBehavior.verboseLogging="Enable verbose logging"
 AdvSceneSwitcher.generalTab.generalBehavior.saveWindowGeo="Save window position and size"
 AdvSceneSwitcher.generalTab.generalBehavior.showTrayNotifications="Show system tray notifications"

diff --git a/forms/advanced-scene-switcher.ui b/forms/advanced-scene-switcher.ui
@@ -163,12 +163,31 @@
                   <item>
                    <layout class="QHBoxLayout" name="horizontalLayout_52">
                     <item>
-                     <widget class="QCheckBox" name="verboseLogging">
+                     <widget class="QLabel" name="label_21">
                       <property name="text">
-                       <string>AdvSceneSwitcher.generalTab.generalBehavior.verboseLogging</string>
+                       <string>AdvSceneSwitcher.generalTab.generalBehavior.logLevel</string>
                       </property>
                      </widget>
                     </item>
+                    <item>
+                     <widget class="QComboBox" name="logLevel">
+                      <item>
+                       <property name="text">
+                        <string>AdvSceneSwitcher.generalTab.generalBehavior.logLevel.default</string>
+                       </property>
+                      </item>
+                      <item>
+                       <property name="text">
+                        <string>AdvSceneSwitcher.generalTab.generalBehavior.logLevel.printActions</string>
+                       </property>
+                      </item>
+                      <item>
+                       <property name="text">
+                        <string>AdvSceneSwitcher.generalTab.generalBehavior.logLevel.verbose</string>
+                       </property>
+                      </item>
+                     </widget>
+                    </item>
                     <item>
                      <spacer name="horizontalSpacer_49">
                       <property name="orientation">
@@ -5078,7 +5097,7 @@
   <tabstop>checkInterval</tabstop>
   <tabstop>startupBehavior</tabstop>
   <tabstop>autoStartEvent</tabstop>
-  <tabstop>verboseLogging</tabstop>
+  <tabstop>logLevel</tabstop>
   <tabstop>saveWindowGeo</tabstop>
   <tabstop>showTrayNotifications</tabstop>
   <tabstop>uiHintsDisable</tabstop>

diff --git a/lib/advanced-scene-switcher.hpp b/lib/advanced-scene-switcher.hpp
@@ -55,14 +55,14 @@ public slots:
 	void NoMatchDelayDurationChanged(const Duration &);
 	void CooldownDurationChanged(const Duration &);
 	void on_startupBehavior_currentIndexChanged(int index);
+	void on_logLevel_currentIndexChanged(int index);
 	void on_autoStartEvent_currentIndexChanged(int index);
 	void on_noMatchSwitchScene_currentTextChanged(const QString &text);
 	void on_checkInterval_valueChanged(int value);
 	void on_tabMoved(int from, int to);
 	void on_tabWidget_currentChanged(int index);
 	void on_exportSettings_clicked();
 	void on_importSettings_clicked();
-	void on_verboseLogging_stateChanged(int state);
 	void on_saveWindowGeo_stateChanged(int state);
 	void on_showTrayNotifications_stateChanged(int state);
 	void on_uiHintsDisable_stateChanged(int state);

diff --git a/lib/general.cpp b/lib/general.cpp
@@ -112,6 +112,14 @@ void AdvSceneSwitcher::on_startupBehavior_currentIndexChanged(int index)
 		static_cast<SwitcherData::StartupBehavior>(index);
 }
 
+void AdvSceneSwitcher::on_logLevel_currentIndexChanged(int value)
+{
+	if (loading) {
+		return;
+	}
+	switcher->logLevel = static_cast<SwitcherData::LogLevel>(value);
+}
+
 void AdvSceneSwitcher::on_autoStartEvent_currentIndexChanged(int index)
 {
 	if (loading) {
@@ -157,15 +165,6 @@ void AdvSceneSwitcher::closeEvent(QCloseEvent *)
 	obs_frontend_save();
 }
 
-void AdvSceneSwitcher::on_verboseLogging_stateChanged(int state)
-{
-	if (loading) {
-		return;
-	}
-
-	switcher->verbose = state;
-}
-
 void AdvSceneSwitcher::on_saveWindowGeo_stateChanged(int state)
 {
 	if (loading) {
@@ -598,7 +597,7 @@ void SwitcherData::SaveGeneralSettings(obs_data_t *obj)
 	obs_data_set_int(obj, "autoStartEvent",
 			 static_cast<int>(autoStartEvent));
 
-	obs_data_set_bool(obj, "verbose", verbose);
+	obs_data_set_int(obj, "logLevel", static_cast<int>(logLevel));
 	obs_data_set_bool(obj, "showSystemTrayNotifications",
 			  showSystemTrayNotifications);
 	obs_data_set_bool(obj, "disableHints", disableHints);
@@ -649,7 +648,7 @@ void SwitcherData::LoadGeneralSettings(obs_data_t *obj)
 	autoStartEvent =
 		static_cast<AutoStart>(obs_data_get_int(obj, "autoStartEvent"));
 
-	verbose = obs_data_get_bool(obj, "verbose");
+	logLevel = static_cast<LogLevel>(obs_data_get_int(obj, "logLevel"));
 	showSystemTrayNotifications =
 		obs_data_get_bool(obj, "showSystemTrayNotifications");
 	disableHints = obs_data_get_bool(obj, "disableHints");
@@ -940,7 +939,8 @@ void AdvSceneSwitcher::SetupGeneralTab()
 			 SIGNAL(DurationChanged(const Duration &)), this,
 			 SLOT(CooldownDurationChanged(const Duration &)));
 
-	ui->verboseLogging->setChecked(switcher->verbose);
+	ui->logLevel->setCurrentIndex(static_cast<int>(switcher->logLevel));
+
 	ui->saveWindowGeo->setChecked(switcher->saveWindowGeo);
 	ui->showTrayNotifications->setChecked(
 		switcher->showSystemTrayNotifications);

diff --git a/lib/legacy/switch-audio.cpp b/lib/legacy/switch-audio.cpp
@@ -104,7 +104,7 @@ void SwitcherData::checkAudioSwitchFallback(OBSWeakSource &scene,
 		scene = audioFallback.getScene();
 		transition = audioFallback.transition;
 
-		if (verbose) {
+		if (VerboseLoggingEnabled()) {
 			audioFallback.logMatch();
 		}
 	}
@@ -165,7 +165,7 @@ bool SwitcherData::checkAudioSwitch(OBSWeakSource &scene,
 			transition = s.transition;
 			match = true;
 
-			if (verbose) {
+			if (VerboseLoggingEnabled()) {
 				s.logMatch();
 			}
 

diff --git a/lib/legacy/switch-executable.cpp b/lib/legacy/switch-executable.cpp
@@ -119,7 +119,7 @@ bool SwitcherData::checkExeSwitch(OBSWeakSource &scene,
 			scene = s.getScene();
 			transition = s.transition;
 
-			if (verbose) {
+			if (VerboseLoggingEnabled()) {
 				s.logMatch();
 			}
 			break;

diff --git a/lib/legacy/switch-file.cpp b/lib/legacy/switch-file.cpp
@@ -274,7 +274,7 @@ bool SwitcherData::checkFileContent(OBSWeakSource &scene,
 			transition = s.transition;
 			match = true;
 
-			if (verbose) {
+			if (VerboseLoggingEnabled()) {
 				s.logMatch();
 			}
 			break;

diff --git a/lib/legacy/switch-idle.cpp b/lib/legacy/switch-idle.cpp
@@ -53,7 +53,7 @@ bool SwitcherData::checkIdleSwitch(OBSWeakSource &scene,
 		match = true;
 		idleData.alreadySwitched = true;
 
-		if (verbose) {
+		if (VerboseLoggingEnabled()) {
 			idleData.logMatch();
 		}
 	} else {

diff --git a/lib/legacy/switch-media.cpp b/lib/legacy/switch-media.cpp
@@ -193,7 +193,7 @@ bool SwitcherData::checkMediaSwitch(OBSWeakSource &scene,
 			scene = mediaSwitch.getScene();
 			transition = mediaSwitch.transition;
 
-			if (verbose) {
+			if (VerboseLoggingEnabled()) {
 				mediaSwitch.logMatch();
 			}
 		}

diff --git a/lib/legacy/switch-network.cpp b/lib/legacy/switch-network.cpp
@@ -253,7 +253,7 @@ void WSServer::sendMessage(SceneSwitchInfo sceneSwitch, bool preview)
 		}
 	}
 
-	if (switcher->verbose) {
+	if (VerboseLoggingEnabled()) {
 		blog(LOG_INFO, "server sent message:\n%s", message.c_str());
 	}
 }
@@ -305,7 +305,7 @@ std::string processMessage(std::string payload)
 	std::string ret = "message ok";
 
 	auto transition = GetWeakTransitionByName(transitionName.c_str());
-	if (switcher->verbose && !transition) {
+	if (VerboseLoggingEnabled() && !transition) {
 		ret += " - ignoring invalid transition: '" + transitionName +
 		       "'";
 	}
@@ -481,7 +481,7 @@ void WSClient::onMessage(connection_hdl hdl, client::message_ptr message)
 		     errorCodeMessage.c_str());
 	}
 
-	if (switcher->verbose) {
+	if (VerboseLoggingEnabled()) {
 		blog(LOG_INFO, "client sent message:\n%s", response.c_str());
 	}
 }

diff --git a/lib/legacy/switch-random.cpp b/lib/legacy/switch-random.cpp
@@ -76,7 +76,7 @@ bool SwitcherData::checkRandom(OBSWeakSource &scene, OBSWeakSource &transition,
 		lastRandomScene = r.scene;
 		lastRandomSceneGroup = r.group;
 
-		if (verbose) {
+		if (VerboseLoggingEnabled()) {
 			r.logMatch();
 		}
 		break;

diff --git a/lib/legacy/switch-screen-region.cpp b/lib/legacy/switch-screen-region.cpp
@@ -183,7 +183,7 @@ bool SwitcherData::checkScreenRegionSwitch(OBSWeakSource &scene,
 				transition = s.transition;
 				minRegionSize = regionSize;
 
-				if (verbose) {
+				if (VerboseLoggingEnabled()) {
 					s.logMatch();
 				}
 				break;

diff --git a/lib/legacy/switch-sequence.cpp b/lib/legacy/switch-sequence.cpp
@@ -225,13 +225,13 @@ bool SwitcherData::checkSceneSequence(OBSWeakSource &scene,
 				scene = s.getScene();
 				transition = s.transition;
 				setPrevSceneAfterLinger = s.usePreviousScene;
-				if (verbose) {
+				if (VerboseLoggingEnabled()) {
 					s.logMatch();
 				}
 			}
 
 			s.advanceActiveSequence();
-			if (verbose) {
+			if (VerboseLoggingEnabled()) {
 				s.logAdvanceSequence();
 			}
 

diff --git a/lib/legacy/switch-time.cpp b/lib/legacy/switch-time.cpp
@@ -142,7 +142,7 @@ bool SwitcherData::checkTimeSwitch(OBSWeakSource &scene,
 			transition = s.transition;
 			match = true;
 
-			if (verbose) {
+			if (VerboseLoggingEnabled()) {
 				s.logMatch();
 			}
 			break;

diff --git a/lib/legacy/switch-transitions.cpp b/lib/legacy/switch-transitions.cpp
@@ -168,7 +168,7 @@ void SwitcherData::checkDefaultSceneTransitions()
 
 	for (auto &t : defaultSceneTransitions) {
 		if (t.checkMatch(currentScene)) {
-			if (verbose) {
+			if (VerboseLoggingEnabled()) {
 				t.logMatch();
 			}
 			t.setTransition();
@@ -427,7 +427,8 @@ DefTransitionSwitchWidget::DefTransitionSwitchWidget(QWidget *parent,
 {
 	QHBoxLayout *mainLayout = new QHBoxLayout;
 	std::unordered_map<std::string, QWidget *> widgetPlaceholders = {
-		{"{{scenes}}", scenes}, {"{{transitions}}", transitions}};
+		{"{{scenes}}", scenes},
+		{"{{transitions}}", transitions}};
 	PlaceWidgets(
 		obs_module_text(
 			"AdvSceneSwitcher.transitionTab.defaultTransitionEntry"),

diff --git a/lib/legacy/switch-video.cpp b/lib/legacy/switch-video.cpp
@@ -148,7 +148,7 @@ bool SwitcherData::checkVideoSwitch(OBSWeakSource &scene,
 			match = true;
 			scene = s.getScene();
 			transition = s.transition;
-			if (verbose) {
+			if (VerboseLoggingEnabled()) {
 				s.logMatch();
 			}
 		}

diff --git a/lib/legacy/switch-window.cpp b/lib/legacy/switch-window.cpp
@@ -249,7 +249,7 @@ bool SwitcherData::checkWindowTitleSwitch(OBSWeakSource &scene,
 		}
 
 		if (match) {
-			if (verbose) {
+			if (VerboseLoggingEnabled()) {
 				s.logMatch();
 			}
 			break;

diff --git a/lib/macro/macro-action-macro.cpp b/lib/macro/macro-action-macro.cpp
@@ -88,32 +88,32 @@ void MacroActionMacro::LogAction() const
 	}
 	switch (_action) {
 	case Action::PAUSE:
-		vblog(LOG_INFO, "paused \"%s\"", macro->Name().c_str());
+		ablog(LOG_INFO, "paused \"%s\"", macro->Name().c_str());
 		break;
 	case Action::UNPAUSE:
-		vblog(LOG_INFO, "unpaused \"%s\"", macro->Name().c_str());
+		ablog(LOG_INFO, "unpaused \"%s\"", macro->Name().c_str());
 		break;
 	case Action::RESET_COUNTER:
-		vblog(LOG_INFO, "reset counter for \"%s\"",
+		ablog(LOG_INFO, "reset counter for \"%s\"",
 		      macro->Name().c_str());
 		break;
 	case Action::RUN:
-		vblog(LOG_INFO, "run nested macro \"%s\"",
+		ablog(LOG_INFO, "run nested macro \"%s\"",
 		      macro->Name().c_str());
 		break;
 	case Action::STOP:
-		vblog(LOG_INFO, "stopped macro \"%s\"", macro->Name().c_str());
+		ablog(LOG_INFO, "stopped macro \"%s\"", macro->Name().c_str());
 		break;
 	case Action::DISABLE_ACTION:
-		vblog(LOG_INFO, "disabled action %d of macro \"%s\"",
+		ablog(LOG_INFO, "disabled action %d of macro \"%s\"",
 		      _actionIndex.GetValue(), macro->Name().c_str());
 		break;
 	case Action::ENABLE_ACTION:
-		vblog(LOG_INFO, "enabled action %d of macro \"%s\"",
+		ablog(LOG_INFO, "enabled action %d of macro \"%s\"",
 		      _actionIndex.GetValue(), macro->Name().c_str());
 		break;
 	case Action::TOGGLE_ACTION:
-		vblog(LOG_INFO, "toggled action %d of macro \"%s\"",
+		ablog(LOG_INFO, "toggled action %d of macro \"%s\"",
 		      _actionIndex.GetValue(), macro->Name().c_str());
 		break;
 	default:

diff --git a/lib/macro/macro-action-queue.cpp b/lib/macro/macro-action-queue.cpp
@@ -69,20 +69,20 @@ void MacroActionQueue::LogAction() const
 	}
 	switch (_action) {
 	case Action::ADD_TO_QUEUE:
-		vblog(LOG_INFO, "queued actions of \"%s\" to \"%s\"",
+		ablog(LOG_INFO, "queued actions of \"%s\" to \"%s\"",
 		      GetMacroName(macro.get()).c_str(),
 		      GetActionQueueName(_queue).c_str());
 		break;
 	case Action::START_QUEUE:
-		vblog(LOG_INFO, "start queue \"%s\"",
+		ablog(LOG_INFO, "start queue \"%s\"",
 		      GetActionQueueName(_queue).c_str());
 		break;
 	case Action::STOP_QUEUE:
-		vblog(LOG_INFO, "stop queue \"%s\"",
+		ablog(LOG_INFO, "stop queue \"%s\"",
 		      GetActionQueueName(_queue).c_str());
 		break;
 	case Action::CLEAR_QUEUE:
-		vblog(LOG_INFO, "cleared queue \"%s\"",
+		ablog(LOG_INFO, "cleared queue \"%s\"",
 		      GetActionQueueName(_queue).c_str());
 		break;
 	default:

diff --git a/lib/macro/macro-action.cpp b/lib/macro/macro-action.cpp
@@ -25,7 +25,7 @@ bool MacroAction::Load(obs_data_t *obj)
 
 void MacroAction::LogAction() const
 {
-	vblog(LOG_INFO, "performed action %s", GetId().c_str());
+	ablog(LOG_INFO, "performed action %s", GetId().c_str());
 }
 
 void MacroAction::SetEnabled(bool value)

diff --git a/lib/switcher-data.hpp b/lib/switcher-data.hpp
@@ -141,7 +141,9 @@ class SwitcherData {
 	bool showSystemTrayNotifications = false;
 	bool transitionOverrideOverride = false;
 	bool adjustActiveTransitionType = true;
-	bool verbose = false;
+
+	enum class LogLevel { DEFAULT, PRINT_ACTION, VERBOSE };
+	LogLevel logLevel = LogLevel::DEFAULT;
 
 	/* --- End of General tab section --- */
 

diff --git a/lib/utils/action-queue.cpp b/lib/utils/action-queue.cpp
@@ -134,8 +134,11 @@ void ActionQueue::RunActions()
 			continue;
 		}
 
-		vblog(LOG_INFO, "Performing action '%s' in queue '%s'",
-		      action->GetId().c_str(), _name.c_str());
+		if (ActionLoggingEnabled()) {
+			blog(LOG_INFO, "Performing action '%s' in queue '%s'",
+			     action->GetId().c_str(), _name.c_str());
+			action->LogAction();
+		}
 		action->PerformAction();
 	}
 }