Renamed ScopeLogger::INFO as ILoggerService::LOG_LEVEL::LOG_LEVEL_INFO to prevent confusion with and SA_LOG(INFO) calls.

end2endzone · end2endzone · commit 7f0a64917066 · 2024-08-24T09:18:27.000-04:00
diff --git a/src/core/ActionManager.cpp b/src/core/ActionManager.cpp
@@ -35,7 +35,7 @@ namespace shellanything
 
   bool ActionManager::Execute(const Menu* menu, const SelectionContext& context)
   {
-    SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+    SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
     sli.verbose = true;
     ScopeLogger logger(&sli);
 
diff --git a/src/core/ConfigFile.cpp b/src/core/ConfigFile.cpp
@@ -121,7 +121,7 @@ namespace shellanything
 
   ConfigFile* ConfigFile::LoadFile(const std::string& path, std::string& error)
   {
-    SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+    SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
     sli.verbose = true;
     ScopeLogger logger(&sli);
 
@@ -347,7 +347,7 @@ namespace shellanything
 
   void ConfigFile::Update(const SelectionContext& context)
   {
-    SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+    SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
     sli.verbose = true;
     sli.instance = this;
     ScopeLogger logger(&sli);
@@ -387,7 +387,7 @@ namespace shellanything
   {
     if (mDefaults && mDefaults->GetActions().size() > 0)
     {
-      SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+      SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
       sli.verbose = true;
       ScopeLogger logger(&sli);
 
diff --git a/src/core/ConfigManager.cpp b/src/core/ConfigManager.cpp
@@ -59,7 +59,7 @@ namespace shellanything
 
   void ConfigManager::Refresh()
   {
-    SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+    SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
     ScopeLogger logger(&sli);
 
     //validate existing configurations
@@ -143,7 +143,7 @@ namespace shellanything
 
   void ConfigManager::Update(const SelectionContext& context)
   {
-    SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+    SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
     sli.verbose = true;
     ScopeLogger logger(&sli);
 
diff --git a/src/core/LoggerHelper.cpp b/src/core/LoggerHelper.cpp
@@ -130,47 +130,47 @@ namespace shellanything
   // ------------------------------------------------------------------------------------------------------------------------------------------------------------
   // ------------------------------------------------------------------------------------------------------------------------------------------------------------
 
-  ScopeLogger::ScopeLogger(const ScopeLogger::INFO* info_) :
-    info(info_)
+  ScopeLogger::ScopeLogger(const ScopeLogger::ARGS* args_) :
+    args(args_)
   {
     // Prepare output text
     std::string text;
-    text += info->name;
-    if (info->instance != NULL)
+    text += args->name;
+    if (args->instance != NULL)
     {
       text += ",this=";
-      text += ToHexString(info->instance);
+      text += ToHexString(args->instance);
     }
 
-    if (info->filename != NULL)
+    if (args->filename != NULL)
     {
-      ::shellanything::LoggerHelper(info->filename, info->line, info->level, info->verbose) << text;
+      ::shellanything::LoggerHelper(args->filename, args->line, args->level, args->verbose) << text;
     }
     else
     {
-      ::shellanything::LoggerHelper(info->level, info->verbose) << text;
+      ::shellanything::LoggerHelper(args->level, args->verbose) << text;
     }
   }
 
   ScopeLogger::~ScopeLogger()
   {
     // Prepare output text
     std::string text;
-    text += info->name;
-    if (info->instance != NULL)
+    text += args->name;
+    if (args->instance != NULL)
     {
       text += ",this=";
-      text += ToHexString(info->instance);
+      text += ToHexString(args->instance);
     }
     text += " - returns";
 
-    if (info->filename != NULL)
+    if (args->filename != NULL)
     {
-      ::shellanything::LoggerHelper(info->filename, info->line, info->level, info->verbose) << text;
+      ::shellanything::LoggerHelper(args->filename, args->line, args->level, args->verbose) << text;
     }
     else
     {
-      ::shellanything::LoggerHelper(info->level, info->verbose) << text;
+      ::shellanything::LoggerHelper(args->level, args->verbose) << text;
     }
   }
 
diff --git a/src/core/LoggerHelper.h b/src/core/LoggerHelper.h
@@ -79,7 +79,7 @@ namespace shellanything
   /// </summary>
   /// <example>
   /// <code>
-  ///   SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+  ///   SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
   ///   sli.verbose = true;
   ///   sli.instance = this;
   ///   ScopeLogger logger(&sli);
@@ -89,9 +89,9 @@ namespace shellanything
   {
   public:
     /// <summary>
-    /// Context for a ScopeManager
+    /// Argument struct for a ScopeManager
     /// </summary>
-    struct INFO
+    struct ARGS
     {
       ///<summary>The souce code filename generating the log entries.</summary>
       const char* filename;
@@ -108,7 +108,7 @@ namespace shellanything
     };
 
   public:
-    ScopeLogger(const ScopeLogger::INFO* info);
+    ScopeLogger(const ScopeLogger::ARGS* info);
     ~ScopeLogger();
 
   private:
@@ -117,12 +117,12 @@ namespace shellanything
     ScopeLogger& operator=(const ScopeLogger&);
 
   public:
-    const INFO* info;
+    const ARGS* args;
   };
 
-  #ifndef SA_DECLARE_SCOPE_LOGGER_INFO
-  #define SA_DECLARE_SCOPE_LOGGER_INFO(info) \
-    ::shellanything::ScopeLogger::INFO info = {0};\
+  #ifndef SA_DECLARE_SCOPE_LOGGER_ARGS
+  #define SA_DECLARE_SCOPE_LOGGER_ARGS(info) \
+    ::shellanything::ScopeLogger::ARGS info = {0};\
     info.filename = __FILE__;\
     info.line = __LINE__;\
     info.name = __FUNCTION__ "()";\
diff --git a/src/core/Menu.cpp b/src/core/Menu.cpp
@@ -207,7 +207,7 @@ namespace shellanything
 
   void Menu::Update(const SelectionContext& context)
   {
-    SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+    SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
     sli.verbose = true;
     sli.instance = this;
     ScopeLogger logger(&sli);
diff --git a/src/core/Plugin.cpp b/src/core/Plugin.cpp
@@ -175,7 +175,7 @@ namespace shellanything
 
   bool Plugin::Load()
   {
-    SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+    SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
     sli.verbose = true;
     sli.instance = this;
     ScopeLogger logger(&sli);
@@ -285,7 +285,7 @@ namespace shellanything
 
   bool Plugin::Unload()
   {
-    SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+    SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
     sli.verbose = true;
     sli.instance = this;
     ScopeLogger logger(&sli);
diff --git a/src/core/PropertyManager.cpp b/src/core/PropertyManager.cpp
@@ -618,7 +618,7 @@ namespace shellanything
 
   void PropertyManager::RegisterEnvironmentVariables()
   {
-    SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+    SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
     sli.verbose = true;
     ScopeLogger logger(&sli);
 
@@ -641,7 +641,7 @@ namespace shellanything
 
   void PropertyManager::RegisterFixedAndDefaultProperties()
   {
-    SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+    SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
     sli.verbose = true;
     ScopeLogger logger(&sli);
 
diff --git a/src/core/SelectionContext.cpp b/src/core/SelectionContext.cpp
@@ -65,7 +65,7 @@ namespace shellanything
 
   void SelectionContext::RegisterProperties() const
   {
-    SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+    SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
     sli.verbose = true;
     sli.instance = this;
     ScopeLogger logger(&sli);
diff --git a/src/core/Validator.cpp b/src/core/Validator.cpp
@@ -360,7 +360,7 @@ namespace shellanything
 
   bool Validator::Validate(const SelectionContext& context) const
   {
-    SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+    SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
     sli.verbose = true;
     sli.instance = this;
     ScopeLogger logger(&sli);
diff --git a/src/shellextension/CContextMenu.cpp b/src/shellextension/CContextMenu.cpp
@@ -55,7 +55,7 @@ static const GUID CLSID_UNDOCUMENTED_01 = { 0x924502a7, 0xcc8e, 0x4f60, { 0xae,
 
 void CContextMenu::BuildMenuTree(HMENU hMenu, shellanything::Menu* menu, UINT& insert_pos, bool& next_menu_is_column)
 {
-  SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+  SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
   sli.verbose = true;
   sli.instance = this;
   shellanything::ScopeLogger logger(&sli);
@@ -268,7 +268,7 @@ void CContextMenu::BuildMenuTree(HMENU hMenu)
   //Every 5 times the shell extension popup is displayed, we look for 'unused' bitmap and delete them.
   //
 
-  SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+  SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
   sli.verbose = true;
   sli.instance = this;
   shellanything::ScopeLogger logger(&sli);
@@ -343,7 +343,7 @@ CContextMenu::~CContextMenu()
 
 HRESULT STDMETHODCALLTYPE CContextMenu::QueryContextMenu(HMENU hMenu, UINT menu_index, UINT first_command_id, UINT max_command_id, UINT flags)
 {
-  SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+  SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
   sli.verbose = true;
   sli.instance = this;
   shellanything::ScopeLogger logger(&sli);
@@ -434,7 +434,7 @@ HRESULT STDMETHODCALLTYPE CContextMenu::QueryContextMenu(HMENU hMenu, UINT menu_
 
 HRESULT STDMETHODCALLTYPE CContextMenu::InvokeCommand(LPCMINVOKECOMMANDINFO pici)
 {
-  SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+  SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
   sli.verbose = true;
   sli.instance = this;
   shellanything::ScopeLogger logger(&sli);
@@ -491,7 +491,7 @@ HRESULT STDMETHODCALLTYPE CContextMenu::InvokeCommand(LPCMINVOKECOMMANDINFO pici
 
 HRESULT STDMETHODCALLTYPE CContextMenu::GetCommandString(UINT_PTR command_id, UINT flags, UINT FAR* reserved, LPSTR pszName, UINT cchMax)
 {
-  SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+  SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
   sli.verbose = true;
   sli.instance = this;
   shellanything::ScopeLogger logger(&sli);
@@ -569,7 +569,7 @@ HRESULT STDMETHODCALLTYPE CContextMenu::GetCommandString(UINT_PTR command_id, UI
 
 HRESULT STDMETHODCALLTYPE CContextMenu::Initialize(LPCITEMIDLIST pIDFolder, LPDATAOBJECT pDataObj, HKEY hRegKey)
 {
-  SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+  SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
   sli.verbose = true;
   sli.instance = this;
   shellanything::ScopeLogger logger(&sli);
diff --git a/src/tests/TestLoggerHelper.cpp b/src/tests/TestLoggerHelper.cpp
@@ -120,7 +120,7 @@ namespace shellanything
     {
       SA_LOG(INFO) << __FUNCTION__ "(), line " << __LINE__ << " is the first line of code";
 
-      SA_DECLARE_SCOPE_LOGGER_INFO(sli);
+      SA_DECLARE_SCOPE_LOGGER_ARGS(sli);
       sli.verbose = true;
       sli.level = ::shellanything::ILoggerService::LOG_LEVEL::LOG_LEVEL_INFO; // force INFO level to make sure it is always visible
       ScopeLogger logger(&sli);

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ namespace shellanything`
`35`	`35`
`36`	`36`	`bool ActionManager::Execute(const Menu* menu, const SelectionContext& context)`
`37`	`37`	`{`
`38`		`- SA_DECLARE_SCOPE_LOGGER_INFO(sli);`
	`38`	`+ SA_DECLARE_SCOPE_LOGGER_ARGS(sli);`
`39`	`39`	`sli.verbose = true;`
`40`	`40`	`ScopeLogger logger(&sli);`
`41`	`41`
Original file line number	Diff line number	Diff line change
`@@ -121,7 +121,7 @@ namespace shellanything`
`121`	`121`
`122`	`122`	`ConfigFile* ConfigFile::LoadFile(const std::string& path, std::string& error)`
`123`	`123`	`{`
`124`		`- SA_DECLARE_SCOPE_LOGGER_INFO(sli);`
	`124`	`+ SA_DECLARE_SCOPE_LOGGER_ARGS(sli);`
`125`	`125`	`sli.verbose = true;`
`126`	`126`	`ScopeLogger logger(&sli);`
`127`	`127`
`@@ -347,7 +347,7 @@ namespace shellanything`
`347`	`347`
`348`	`348`	`void ConfigFile::Update(const SelectionContext& context)`
`349`	`349`	`{`
`350`		`- SA_DECLARE_SCOPE_LOGGER_INFO(sli);`
	`350`	`+ SA_DECLARE_SCOPE_LOGGER_ARGS(sli);`
`351`	`351`	`sli.verbose = true;`
`352`	`352`	`sli.instance = this;`
`353`	`353`	`ScopeLogger logger(&sli);`
`@@ -387,7 +387,7 @@ namespace shellanything`
`387`	`387`	`{`
`388`	`388`	`if (mDefaults && mDefaults->GetActions().size() > 0)`
`389`	`389`	`{`
`390`		`- SA_DECLARE_SCOPE_LOGGER_INFO(sli);`
	`390`	`+ SA_DECLARE_SCOPE_LOGGER_ARGS(sli);`
`391`	`391`	`sli.verbose = true;`
`392`	`392`	`ScopeLogger logger(&sli);`
`393`	`393`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ namespace shellanything`
`59`	`59`
`60`	`60`	`void ConfigManager::Refresh()`
`61`	`61`	`{`
`62`		`- SA_DECLARE_SCOPE_LOGGER_INFO(sli);`
	`62`	`+ SA_DECLARE_SCOPE_LOGGER_ARGS(sli);`
`63`	`63`	`ScopeLogger logger(&sli);`
`64`	`64`
`65`	`65`	`//validate existing configurations`
`@@ -143,7 +143,7 @@ namespace shellanything`
`143`	`143`
`144`	`144`	`void ConfigManager::Update(const SelectionContext& context)`
`145`	`145`	`{`
`146`		`- SA_DECLARE_SCOPE_LOGGER_INFO(sli);`
	`146`	`+ SA_DECLARE_SCOPE_LOGGER_ARGS(sli);`
`147`	`147`	`sli.verbose = true;`
`148`	`148`	`ScopeLogger logger(&sli);`
`149`	`149`
Original file line number	Diff line number	Diff line change
`@@ -130,47 +130,47 @@ namespace shellanything`
`130`	`130`	`// ------------------------------------------------------------------------------------------------------------------------------------------------------------`
`131`	`131`	`// ------------------------------------------------------------------------------------------------------------------------------------------------------------`
`132`	`132`
`133`		`- ScopeLogger::ScopeLogger(const ScopeLogger::INFO* info_) :`
`134`		`- info(info_)`
	`133`	`+ ScopeLogger::ScopeLogger(const ScopeLogger::ARGS* args_) :`
	`134`	`+ args(args_)`
`135`	`135`	`{`
`136`	`136`	`// Prepare output text`
`137`	`137`	`std::string text;`
`138`		`- text += info->name;`
`139`		`- if (info->instance != NULL)`
	`138`	`+ text += args->name;`
	`139`	`+ if (args->instance != NULL)`
`140`	`140`	`{`
`141`	`141`	`text += ",this=";`
`142`		`- text += ToHexString(info->instance);`
	`142`	`+ text += ToHexString(args->instance);`
`143`	`143`	`}`
`144`	`144`
`145`		`- if (info->filename != NULL)`
	`145`	`+ if (args->filename != NULL)`
`146`	`146`	`{`
`147`		`- ::shellanything::LoggerHelper(info->filename, info->line, info->level, info->verbose) << text;`
	`147`	`+ ::shellanything::LoggerHelper(args->filename, args->line, args->level, args->verbose) << text;`
`148`	`148`	`}`
`149`	`149`	`else`
`150`	`150`	`{`
`151`		`- ::shellanything::LoggerHelper(info->level, info->verbose) << text;`
	`151`	`+ ::shellanything::LoggerHelper(args->level, args->verbose) << text;`
`152`	`152`	`}`
`153`	`153`	`}`
`154`	`154`
`155`	`155`	`ScopeLogger::~ScopeLogger()`
`156`	`156`	`{`
`157`	`157`	`// Prepare output text`
`158`	`158`	`std::string text;`
`159`		`- text += info->name;`
`160`		`- if (info->instance != NULL)`
	`159`	`+ text += args->name;`
	`160`	`+ if (args->instance != NULL)`
`161`	`161`	`{`
`162`	`162`	`text += ",this=";`
`163`		`- text += ToHexString(info->instance);`
	`163`	`+ text += ToHexString(args->instance);`
`164`	`164`	`}`
`165`	`165`	`text += " - returns";`
`166`	`166`
`167`		`- if (info->filename != NULL)`
	`167`	`+ if (args->filename != NULL)`
`168`	`168`	`{`
`169`		`- ::shellanything::LoggerHelper(info->filename, info->line, info->level, info->verbose) << text;`
	`169`	`+ ::shellanything::LoggerHelper(args->filename, args->line, args->level, args->verbose) << text;`
`170`	`170`	`}`
`171`	`171`	`else`
`172`	`172`	`{`
`173`		`- ::shellanything::LoggerHelper(info->level, info->verbose) << text;`
	`173`	`+ ::shellanything::LoggerHelper(args->level, args->verbose) << text;`
`174`	`174`	`}`
`175`	`175`	`}`
`176`	`176`
Original file line number	Diff line number	Diff line change
`@@ -207,7 +207,7 @@ namespace shellanything`
`207`	`207`
`208`	`208`	`void Menu::Update(const SelectionContext& context)`
`209`	`209`	`{`
`210`		`- SA_DECLARE_SCOPE_LOGGER_INFO(sli);`
	`210`	`+ SA_DECLARE_SCOPE_LOGGER_ARGS(sli);`
`211`	`211`	`sli.verbose = true;`
`212`	`212`	`sli.instance = this;`
`213`	`213`	`ScopeLogger logger(&sli);`
Original file line number	Diff line number	Diff line change
`@@ -618,7 +618,7 @@ namespace shellanything`
`618`	`618`
`619`	`619`	`void PropertyManager::RegisterEnvironmentVariables()`
`620`	`620`	`{`
`621`		`- SA_DECLARE_SCOPE_LOGGER_INFO(sli);`
	`621`	`+ SA_DECLARE_SCOPE_LOGGER_ARGS(sli);`
`622`	`622`	`sli.verbose = true;`
`623`	`623`	`ScopeLogger logger(&sli);`
`624`	`624`
`@@ -641,7 +641,7 @@ namespace shellanything`
`641`	`641`
`642`	`642`	`void PropertyManager::RegisterFixedAndDefaultProperties()`
`643`	`643`	`{`
`644`		`- SA_DECLARE_SCOPE_LOGGER_INFO(sli);`
	`644`	`+ SA_DECLARE_SCOPE_LOGGER_ARGS(sli);`
`645`	`645`	`sli.verbose = true;`
`646`	`646`	`ScopeLogger logger(&sli);`
`647`	`647`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ namespace shellanything`
`65`	`65`
`66`	`66`	`void SelectionContext::RegisterProperties() const`
`67`	`67`	`{`
`68`		`- SA_DECLARE_SCOPE_LOGGER_INFO(sli);`
	`68`	`+ SA_DECLARE_SCOPE_LOGGER_ARGS(sli);`
`69`	`69`	`sli.verbose = true;`
`70`	`70`	`sli.instance = this;`
`71`	`71`	`ScopeLogger logger(&sli);`
Original file line number	Diff line number	Diff line change
`@@ -360,7 +360,7 @@ namespace shellanything`
`360`	`360`
`361`	`361`	`bool Validator::Validate(const SelectionContext& context) const`
`362`	`362`	`{`
`363`		`- SA_DECLARE_SCOPE_LOGGER_INFO(sli);`
	`363`	`+ SA_DECLARE_SCOPE_LOGGER_ARGS(sli);`
`364`	`364`	`sli.verbose = true;`
`365`	`365`	`sli.instance = this;`
`366`	`366`	`ScopeLogger logger(&sli);`