Refactor log helpers and add option to disable logging

data/locale/de-DE.ini

@@ -26,7 +26,6 @@ AdvSceneSwitcher.generalTab.generalBehavior.onNoMatch.switchToRandom="Wechsle zu
 AdvSceneSwitcher.generalTab.generalBehavior.onNoMatch.switchTo="Wechsle zu:"
 AdvSceneSwitcher.generalTab.generalBehavior.cooldown="Nach Ausführen von Aktionen überspringe das Ausführen von Aktionen für"
 AdvSceneSwitcher.generalTab.generalBehavior.cooldownHint="In diesem Zeitraum werden potentielle erfüllte Bedingungen ignoriert!"
-AdvSceneSwitcher.generalTab.generalBehavior.verboseLogging="Ausführliches Logging"
 AdvSceneSwitcher.generalTab.generalBehavior.saveWindowGeo="Fensterposition und -größe speichern"
 AdvSceneSwitcher.generalTab.generalBehavior.showTrayNotifications="Benachrichtigungen im System-Tray anzeigen"
 AdvSceneSwitcher.generalTab.generalBehavior.disableUIHints="Deaktiviere UI Tipps"

data/locale/en-US.ini

@@ -29,11 +29,11 @@ AdvSceneSwitcher.generalTab.generalBehavior.onNoMatch.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.disable="Disable logging"
 AdvSceneSwitcher.generalTab.generalBehavior.logLevel.default="Default"
 AdvSceneSwitcher.generalTab.generalBehavior.logLevel.logMacro="Log executed macros"
 AdvSceneSwitcher.generalTab.generalBehavior.logLevel.logAction="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"
 AdvSceneSwitcher.generalTab.generalBehavior.disableUIHints="Disable UI hints"

data/locale/es-ES.ini

@@ -25,7 +25,6 @@ AdvSceneSwitcher.generalTab.generalBehavior.onNoMatch.dontSwitch="No cambiar"
 AdvSceneSwitcher.generalTab.generalBehavior.onNoMatch.switchToRandom="Cambiar a una escena aleatoria"
 AdvSceneSwitcher.generalTab.generalBehavior.onNoMatch.switchTo="Cambiar a:"
 AdvSceneSwitcher.generalTab.generalBehavior.cooldownHint="¡Durante este tiempo, se ignorarán las posibles coincidencias!"
-AdvSceneSwitcher.generalTab.generalBehavior.verboseLogging="Habilitar el registro detallado"
 AdvSceneSwitcher.generalTab.generalBehavior.saveWindowGeo="Guardar la posición y el tamaño de la ventana"
 AdvSceneSwitcher.generalTab.generalBehavior.showTrayNotifications="Mostrar notificaciones del sistema"
 AdvSceneSwitcher.generalTab.generalBehavior.disableUIHints="Deshabilitar sugerencias de interfaz de usuario"

data/locale/fr-FR.ini

@@ -26,7 +26,6 @@ AdvSceneSwitcher.generalTab.generalBehavior.onNoMatch.switchToRandom="Basculer v
 AdvSceneSwitcher.generalTab.generalBehavior.onNoMatch.switchTo="Basculer vers :"
 AdvSceneSwitcher.generalTab.generalBehavior.cooldown="Après avoir effectué des actions, sauter l'exécution d'actions pendant"
 AdvSceneSwitcher.generalTab.generalBehavior.cooldownHint="Pendant cette période, les correspondances potentielles seront ignorées !"
-AdvSceneSwitcher.generalTab.generalBehavior.verboseLogging="Activer les journaux détaillés"
 AdvSceneSwitcher.generalTab.generalBehavior.saveWindowGeo="Enregistrer la position et la taille de la fenêtre"
 AdvSceneSwitcher.generalTab.generalBehavior.showTrayNotifications="Afficher les notifications dans la zone de notification système"
 AdvSceneSwitcher.generalTab.generalBehavior.disableUIHints="Désactiver les indications de l'interface utilisateur"

data/locale/ja-JP.ini

@@ -30,7 +30,6 @@ AdvSceneSwitcher.generalTab.generalBehavior.logLevel="ログレベル："
 AdvSceneSwitcher.generalTab.generalBehavior.logLevel.default="デフォルト"
 AdvSceneSwitcher.generalTab.generalBehavior.logLevel.logAction="実行されたアクションのログ"
 AdvSceneSwitcher.generalTab.generalBehavior.logLevel.verbose="詳細ログ（Verbose）"
-AdvSceneSwitcher.generalTab.generalBehavior.verboseLogging="詳細ログを有効にする（生成されるログファイルのサイズが増加します）"
 AdvSceneSwitcher.generalTab.generalBehavior.saveWindowGeo="ウィンドウのサイズと位置を記憶する"
 AdvSceneSwitcher.generalTab.generalBehavior.showTrayNotifications="システムトレイ通知を表示"
 AdvSceneSwitcher.generalTab.generalBehavior.disableUIHints="UIヒントを無効にする"

data/locale/pt-BR.ini

@@ -30,7 +30,6 @@ AdvSceneSwitcher.generalTab.generalBehavior.logLevel="Nível de log:"
 AdvSceneSwitcher.generalTab.generalBehavior.logLevel.default="Padrão"
 AdvSceneSwitcher.generalTab.generalBehavior.logLevel.logAction="Registrar ações executadas"
 AdvSceneSwitcher.generalTab.generalBehavior.logLevel.verbose="Registro detalhado"
-AdvSceneSwitcher.generalTab.generalBehavior.verboseLogging="Ativar registro detalhado"
 AdvSceneSwitcher.generalTab.generalBehavior.saveWindowGeo="Salvar posição e tamanho da janela"
 AdvSceneSwitcher.generalTab.generalBehavior.showTrayNotifications="Mostrar notificações na área de notificação"
 AdvSceneSwitcher.generalTab.generalBehavior.disableUIHints="Desativar dicas de interface"

data/locale/ru-RU.ini

@@ -25,7 +25,6 @@ AdvSceneSwitcher.generalTab.generalBehavior.onNoMatch.dontSwitch="Не пере
 AdvSceneSwitcher.generalTab.generalBehavior.onNoMatch.switchToRandom="Переключиться на любую сцену на вкладке Random"
 AdvSceneSwitcher.generalTab.generalBehavior.onNoMatch.switchTo="Переключиться на:"
 AdvSceneSwitcher.generalTab.generalBehavior.cooldownHint="В течение этого времени потенциальные совпадения будут игнорироваться!"
-AdvSceneSwitcher.generalTab.generalBehavior.verboseLogging="Включить ведение подробного журнала"
 AdvSceneSwitcher.generalTab.generalBehavior.saveWindowGeo="Сохранять положение и размер окна"
 AdvSceneSwitcher.generalTab.generalBehavior.disableUIHints="Отключить подсказки пользовательского интерфейса"
 AdvSceneSwitcher.generalTab.priority="Приоритет"

data/locale/tr-TR.ini

@@ -26,7 +26,6 @@ AdvSceneSwitcher.generalTab.generalBehavior.onNoMatch.switchToRandom="Rastgele s
 AdvSceneSwitcher.generalTab.generalBehavior.onNoMatch.switchTo="Değiştirmek:"
 AdvSceneSwitcher.generalTab.generalBehavior.cooldown="Bir eşleşmeden sonra aşağıdakiler için işlem yapmayın:"
 AdvSceneSwitcher.generalTab.generalBehavior.cooldownHint="Bu süre zarfında olası eşleşmeler göz ardı edilecektir!"
-AdvSceneSwitcher.generalTab.generalBehavior.verboseLogging="Ayrıntılı günlük kaydını etkinleştir"
 AdvSceneSwitcher.generalTab.generalBehavior.saveWindowGeo="Pencere konumunu ve boyutunu kaydet"
 AdvSceneSwitcher.generalTab.generalBehavior.showTrayNotifications="Sistem tepsisi bildirimlerini göster"
 AdvSceneSwitcher.generalTab.generalBehavior.disableUIHints="UI ipuçlarını devre dışı bırak"

data/locale/zh-CN.ini

@@ -33,7 +33,6 @@ AdvSceneSwitcher.generalTab.generalBehavior.logLevel.default="默认"
 AdvSceneSwitcher.generalTab.generalBehavior.logLevel.logMacro="记录已执行的宏"
 AdvSceneSwitcher.generalTab.generalBehavior.logLevel.logAction="记录已执行的操作"
 AdvSceneSwitcher.generalTab.generalBehavior.logLevel.verbose="记录所有信息"
-AdvSceneSwitcher.generalTab.generalBehavior.verboseLogging="详细日志输出"
 AdvSceneSwitcher.generalTab.generalBehavior.saveWindowGeo="保存窗口位置和大小"
 AdvSceneSwitcher.generalTab.generalBehavior.showTrayNotifications="显示系统托盘通知"
 AdvSceneSwitcher.generalTab.generalBehavior.disableUIHints="禁用UI提示"

forms/advanced-scene-switcher.ui

@@ -182,26 +182,6 @@
                     </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.logMacro</string>
-                       </property>
-                      </item>
-                      <item>
-                       <property name="text">
-                        <string>AdvSceneSwitcher.generalTab.generalBehavior.logLevel.logAction</string>
-                       </property>
-                      </item>
-                      <item>
-                       <property name="text">
-                        <string>AdvSceneSwitcher.generalTab.generalBehavior.logLevel.verbose</string>
-                       </property>
-                      </item>
                      </widget>
                     </item>
                     <item>

lib/general.cpp

@@ -113,12 +113,12 @@ void AdvSceneSwitcher::on_startupBehavior_currentIndexChanged(int index)
 		static_cast<SwitcherData::StartupBehavior>(index);
 }
 
-void AdvSceneSwitcher::on_logLevel_currentIndexChanged(int value)
+void AdvSceneSwitcher::on_logLevel_currentIndexChanged(int idx)
 {
 	if (loading) {
 		return;
 	}
-	switcher->logLevel = static_cast<SwitcherData::LogLevel>(value);
+	SetLogLevel(static_cast<LogLevel>(ui->logLevel->itemData(idx).toInt()));
 }
 
 void AdvSceneSwitcher::on_autoStartEvent_currentIndexChanged(int index)
@@ -529,8 +529,8 @@ void SwitcherData::SaveGeneralSettings(obs_data_t *obj)
 	obs_data_set_int(obj, "autoStartEvent",
 			 static_cast<int>(autoStartEvent));
 
-	obs_data_set_int(obj, "logLevel", static_cast<int>(logLevel));
-	obs_data_set_int(obj, "logLevelVersion", 1);
+	SaveLogLevel(obj);
+
 	obs_data_set_bool(obj, "showSystemTrayNotifications",
 			  showSystemTrayNotifications);
 	obs_data_set_bool(obj, "disableHints", disableHints);
@@ -586,25 +586,7 @@ void SwitcherData::LoadGeneralSettings(obs_data_t *obj)
 	autoStartEvent =
 		static_cast<AutoStart>(obs_data_get_int(obj, "autoStartEvent"));
 
-	logLevel = static_cast<LogLevel>(obs_data_get_int(obj, "logLevel"));
-	if (obs_data_get_int(obj, "logLevelVersion") < 1) {
-		enum OldLogLevel { DEFAULT, LOG_ACTION, VERBOSE };
-		OldLogLevel oldLogLevel = static_cast<OldLogLevel>(
-			obs_data_get_int(obj, "logLevel"));
-		switch (oldLogLevel) {
-		case DEFAULT:
-			logLevel = LogLevel::DEFAULT;
-			break;
-		case LOG_ACTION:
-			logLevel = LogLevel::LOG_ACTION;
-			break;
-		case VERBOSE:
-			logLevel = LogLevel::VERBOSE;
-			break;
-		default:
-			break;
-		}
-	}
+	LoadLogLevel(obj);
 
 	showSystemTrayNotifications =
 		obs_data_get_bool(obj, "showSystemTrayNotifications");
@@ -894,7 +876,9 @@ void AdvSceneSwitcher::SetupGeneralTab()
 			 SIGNAL(DurationChanged(const Duration &)), this,
 			 SLOT(CooldownDurationChanged(const Duration &)));
 
-	ui->logLevel->setCurrentIndex(static_cast<int>(switcher->logLevel));
+	PopulateLogLevelSelection(ui->logLevel);
+	ui->logLevel->setCurrentIndex(
+		ui->logLevel->findData(static_cast<int>(GetLogLevel())));
 
 	ui->saveWindowGeo->setChecked(switcher->saveWindowGeo);
 	ui->showTrayNotifications->setChecked(

lib/switcher-data.hpp

@@ -132,9 +132,6 @@ public:
 	bool transitionOverrideOverride = false;
 	bool adjustActiveTransitionType = true;
 
-	enum class LogLevel { DEFAULT, LOG_MACRO, LOG_ACTION, VERBOSE };
-	LogLevel logLevel = LogLevel::DEFAULT;
-
 	/* --- End of General tab section --- */
 
 	std::string lastTitle;

lib/utils/log-helper.cpp

@@ -1,26 +1,97 @@
 #include "log-helper.hpp"
-#include "switcher-data.hpp"
+#include "obs-module-helper.hpp"
+
+#include <map>
+#include <obs-data.h>
+#include <QComboBox>
+#include <string>
 
 namespace advss {
 
+static LogLevel logLevel = LogLevel::DEFAULT;
+
 bool VerboseLoggingEnabled()
 {
-	return GetSwitcher() &&
-	       GetSwitcher()->logLevel == SwitcherData::LogLevel::VERBOSE;
+	return logLevel == LogLevel::VERBOSE;
 }
 
 bool ActionLoggingEnabled()
 {
-	return GetSwitcher() &&
-	       (GetSwitcher()->logLevel == SwitcherData::LogLevel::LOG_ACTION ||
-		VerboseLoggingEnabled());
+	return logLevel == LogLevel::LOG_ACTION || VerboseLoggingEnabled();
 }
 
 bool MacroLoggingEnabled()
 {
-	return GetSwitcher() &&
-	       (GetSwitcher()->logLevel == SwitcherData::LogLevel::LOG_MACRO ||
-		ActionLoggingEnabled());
+	return logLevel == LogLevel::LOG_MACRO || ActionLoggingEnabled();
+}
+
+bool LoggingEnabled()
+{
+	return logLevel != LogLevel::DISABLE;
+}
+
+void SetLogLevel(LogLevel newLogLevel)
+{
+	logLevel = newLogLevel;
+}
+
+LogLevel GetLogLevel()
+{
+	return logLevel;
+}
+
+void SaveLogLevel(void *data)
+{
+	auto obj = static_cast<obs_data_t *>(data);
+	obs_data_set_int(obj, "logLevel", static_cast<int>(logLevel));
+	obs_data_set_int(obj, "logLevelVersion", 1);
+}
+
+void LoadLogLevel(void *data)
+{
+	auto obj = static_cast<obs_data_t *>(data);
+	logLevel = static_cast<LogLevel>(obs_data_get_int(obj, "logLevel"));
+	if (obs_data_get_int(obj, "logLevelVersion") < 1) {
+		enum OldLogLevel { DEFAULT, LOG_ACTION, VERBOSE };
+		OldLogLevel oldLogLevel = static_cast<OldLogLevel>(
+			obs_data_get_int(obj, "logLevel"));
+		switch (oldLogLevel) {
+		case DEFAULT:
+			logLevel = LogLevel::DEFAULT;
+			break;
+		case LOG_ACTION:
+			logLevel = LogLevel::LOG_ACTION;
+			break;
+		case VERBOSE:
+			logLevel = LogLevel::VERBOSE;
+			break;
+		default:
+			break;
+		}
+	}
+}
+
+void PopulateLogLevelSelection(void *sel)
+{
+	auto selection = static_cast<QComboBox *>(sel);
+	static const std::map<LogLevel, std::string> logLevels = {
+		{LogLevel::DISABLE,
+		 "AdvSceneSwitcher.generalTab.generalBehavior.logLevel.disable"},
+		{LogLevel::DEFAULT,
+		 "AdvSceneSwitcher.generalTab.generalBehavior.logLevel.default"},
+		{LogLevel::LOG_MACRO,
+		 "AdvSceneSwitcher.generalTab.generalBehavior.logLevel.logMacro"},
+		{LogLevel::LOG_ACTION,
+		 "AdvSceneSwitcher.generalTab.generalBehavior.logLevel.logAction"},
+		{LogLevel::VERBOSE,
+		 "AdvSceneSwitcher.generalTab.generalBehavior.logLevel.verbose"},
+	};
+
+	selection->clear();
+	for (const auto &[value, name] : logLevels) {
+		selection->addItem(obs_module_text(name.c_str()),
+				   static_cast<int>(value));
+	}
 }
 
 } // namespace advss

lib/utils/log-helper.hpp

@@ -12,7 +12,13 @@ namespace advss {
 #else
 
 // Print log with "[adv-ss] " prefix
-#define blog(level, msg, ...) blog(level, "[adv-ss] " msg, ##__VA_ARGS__)
+#define blog(level, msg, ...)                                        \
+	do {                                                         \
+		if (LoggingEnabled()) {                              \
+			blog(level, "[adv-ss] " msg, ##__VA_ARGS__); \
+		}                                                    \
+	} while (0)
+
 // Print log with "[adv-ss] " if log level is set to "verbose"
 #define vblog(level, msg, ...)                           \
 	do {                                             \
@@ -43,5 +49,15 @@ EXPORT bool VerboseLoggingEnabled();
 EXPORT bool ActionLoggingEnabled();
 // Returns true if log level is set to "macro", "action" or "verbose"
 EXPORT bool MacroLoggingEnabled();
+// Returns true if logging is enabled and false otherwise
+EXPORT bool LoggingEnabled();
+
+enum class LogLevel { DISABLE = -1, DEFAULT, LOG_MACRO, LOG_ACTION, VERBOSE };
+
+void SetLogLevel(LogLevel);
+LogLevel GetLogLevel();
+void SaveLogLevel(void *data);
+void LoadLogLevel(void *data);
+void PopulateLogLevelSelection(void *);
 
 } // namespace advss

lib/utils/websocket-api.cpp

@@ -1,8 +1,10 @@
 #include "websocket-api.hpp"
-#include "log-helper.hpp"
 #include "obs-websocket-api.h"
 #include "plugin-state-helpers.hpp"
 
+// Must be after "obs-websocket-api.h" to avoid logging function conflict
+#include "log-helper.hpp"
+
 #include <mutex>
 
 namespace advss {

plugins/base/utils/websocket-helpers.cpp

@@ -1,6 +1,5 @@
 #include "websocket-helpers.hpp"
 #include "connection-manager.hpp"
-#include "log-helper.hpp"
 #include "plugin-state-helpers.hpp"
 #include "sync-helpers.hpp"
 #include "websocket-api.hpp"
@@ -8,6 +7,9 @@
 #include <QCryptographicHash>
 #include <obs-websocket-api.h>
 
+// Must be after "obs-websocket-api.h" to avoid logging function conflict
+#include "log-helper.hpp"
+
 namespace advss {
 
 using websocketpp::lib::placeholders::_1;