Created new interface IIconResolutionService and a default implementation LegacyIconResolutionService.

Author: end2endzone

src/core/App.cpp

@@ -137,6 +137,16 @@ namespace shellanything
     return mRandom;
   }
 
+  void App::SetIconResolutionService(IIconResolutionService* instance)
+  {
+    mIconResolutionService = instance;
+  }
+
+  IIconResolutionService* App::GetIconResolutionService()
+  {
+    return mIconResolutionService;
+  }
+
   bool App::IsTestingEnvironment()
   {
     std::string process_path = ra::process::GetCurrentProcessPath();

src/core/App.h

@@ -30,6 +30,7 @@
 #include "IClipboardService.h"
 #include "IKeyboardService.h"
 #include "IRandomService.h"
+#include "IIconResolutionService.h"
 
 #include <string>
 
@@ -144,6 +145,21 @@ namespace shellanything
     /// <returns>Returns a pointer of the instance that is currently set. Returns NULL if no service is set.</returns>
     IRandomService* GetRandomService();
 
+    /// <summary>
+    /// Set the current application icon resolution service.
+    /// </summary>
+    /// <remarks>
+    /// If a service instance is already set, the caller must properly destroy the old instance.
+    /// </remarks>
+    /// <param name="instance">A valid instance of a the service.</param>
+    void SetIconResolutionService(IIconResolutionService* instance);
+
+    /// <summary>
+    /// Get the current application random service.
+    /// </summary>
+    /// <returns>Returns a pointer of the instance that is currently set. Returns NULL if no service is set.</returns>
+    IIconResolutionService* GetIconResolutionService();
+
     /// <summary>
     /// Test if application is loaded in a test environment (main's tests executable).
     /// </summary>
@@ -199,6 +215,7 @@ namespace shellanything
     IClipboardService* mClipboard;
     IKeyboardService* mKeyboard;
     IRandomService* mRandom;
+    IIconResolutionService* mIconResolutionService;
   };
 
 

src/core/CMakeLists.txt

@@ -18,6 +18,7 @@ set(SHELLANYTHING_CORE_HEADER_FILES ""
   ${CMAKE_SOURCE_DIR}/src/core/Environment.h
   ${CMAKE_SOURCE_DIR}/src/core/Icon.h
   ${CMAKE_SOURCE_DIR}/src/core/IObject.h
+  ${CMAKE_SOURCE_DIR}/src/core/IIconResolutionService.h
   ${CMAKE_SOURCE_DIR}/src/core/IKeyboardService.h
   ${CMAKE_SOURCE_DIR}/src/core/ILiveProperty.h
   ${CMAKE_SOURCE_DIR}/src/core/IClipboardService.h
@@ -62,6 +63,7 @@ add_library(sa.core SHARED
   IAttributeValidator.cpp
   Icon.cpp
   IObject.cpp
+  IIconResolutionService.cpp
   IKeyboardService.cpp
   ILiveProperty.cpp
   IClipboardService.cpp

src/core/IIconResolutionService.cpp

@@ -0,0 +1,38 @@
+/**********************************************************************************
+ * MIT License
+ *
+ * Copyright (c) 2018 Antoine Beauchamp
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *********************************************************************************/
+
+#include "IIconResolutionService.h"
+
+namespace shellanything
+{
+
+  IIconResolutionService::IIconResolutionService()
+  {
+  }
+
+  IIconResolutionService::~IIconResolutionService()
+  {
+  }
+
+} //namespace shellanything

src/core/IIconResolutionService.h

@@ -0,0 +1,63 @@
+/**********************************************************************************
+ * MIT License
+ *
+ * Copyright (c) 2018 Antoine Beauchamp
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *********************************************************************************/
+
+#ifndef SA_IICON_RESOLUTION_SERVICE_H
+#define SA_IICON_RESOLUTION_SERVICE_H
+
+#include "shellanything/export.h"
+#include "shellanything/config.h"
+#include "Icon.h"
+
+#include <stdint.h>
+
+namespace shellanything
+{
+  /// <summary>
+  /// Abstract icon resolution service class.
+  /// Used to decouple the core from the operating system.
+  /// </summary>
+  class SHELLANYTHING_EXPORT IIconResolutionService
+  {
+  public:
+    IIconResolutionService();
+    virtual ~IIconResolutionService();
+
+  private:
+    // Disable and copy constructor, dtor and copy operator
+    IIconResolutionService(const IIconResolutionService&);
+    IIconResolutionService& operator=(const IIconResolutionService&);
+  public:
+
+    /// <summary>
+    /// Resolve an icon's file extension to the system icon for this file extension.
+    /// </summary>
+    /// <param name="icon">The icon that have its fileextension's attribute set to resolve.</param>
+    /// <returns>Returns true if the operation is successful. Returns false otherwise.</returns>
+    virtual bool ResolveFileExtensionIcon(Icon & icon) = 0;
+
+  };
+
+} //namespace shellanything
+
+#endif //SA_IICON_RESOLUTION_SERVICE_H

src/shellextension/dllmain.cpp

@@ -39,6 +39,7 @@
 #include "WindowsClipboardService.h"
 #include "WindowsKeyboardService.h"
 #include "PcgRandomService.h"
+#include "LegacyIconResolutionService.h"
 
 #include "shellanything/version.h"
 #include "shellanything/config.h"
@@ -55,6 +56,7 @@ shellanything::IRegistryService* registry_service = NULL;
 shellanything::IClipboardService* clipboard_service = NULL;
 shellanything::IKeyboardService* keyboard_service = NULL;
 shellanything::IRandomService* random_service = NULL;
+shellanything::IIconResolutionService* icon_resolution_service = NULL;
 
 class CShellAnythingModule : public ATL::CAtlDllModuleT< CShellAnythingModule >
 {
@@ -198,6 +200,10 @@ extern "C" int APIENTRY DllMain(HINSTANCE hInstance, DWORD dwReason, LPVOID lpRe
       random_service = new shellanything::PcgRandomService();
       app.SetRandomService(random_service);
 
+      // Setup an active icon resolution service in ShellAnything's core.
+      icon_resolution_service = new shellanything::LegacyIconResolutionService();
+      app.SetIconResolutionService(icon_resolution_service);
+
       // Setup and starting application
       app.Start();
 
@@ -218,11 +224,13 @@ extern "C" int APIENTRY DllMain(HINSTANCE hInstance, DWORD dwReason, LPVOID lpRe
       delete clipboard_service;
       delete registry_service;
       delete logger_service;
+      delete icon_resolution_service;
       random_service = NULL;
       keyboard_service = NULL;
       clipboard_service = NULL;
       registry_service = NULL;
       logger_service = NULL;
+      icon_resolution_service = NULL;
     }
   }
 

src/tests/main.cpp

@@ -50,6 +50,7 @@
 #include "WindowsClipboardService.h"
 #include "TestKeyboardService.h"
 #include "PcgRandomService.h"
+#include "LegacyIconResolutionService.h"
 #include "ConfigManager.h"
 
 using namespace ra;
@@ -147,6 +148,10 @@ int main(int argc, char** argv)
   shellanything::IRandomService* random_service = new shellanything::PcgRandomService();
   app.SetRandomService(random_service);
 
+  // Setup an active icon resolution service in ShellAnything's core.
+  shellanything::IIconResolutionService* icon_resolution_service = new shellanything::LegacyIconResolutionService();
+  app.SetIconResolutionService(icon_resolution_service);
+
   //Issue #60 - Unit tests cannot execute from installation directory.
   //Create log directory under the current executable.
   //When running tests from a developer environment, the log directory is expected to have write access.
@@ -208,11 +213,13 @@ int main(int argc, char** argv)
   delete clipboard_service;
   delete registry_service;
   delete logger_service;
+  delete icon_resolution_service;
   random_service = NULL;
   keyboard_service = NULL;
   clipboard_service = NULL;
   registry_service = NULL;
   logger_service = NULL;
+  icon_resolution_service = NULL;
 
   return wResult; // returns 0 if all the tests are successful, or 1 otherwise
 }

src/windows/CMakeLists.txt

@@ -1,5 +1,7 @@
 add_library(sa.windows SHARED
   dllmain.cpp
+  LegacyIconResolutionService.cpp
+  LegacyIconResolutionService.h
   Win32Clipboard.cpp
   Win32Clipboard.h
   WindowsClipboardService.cpp

src/windows/LegacyIconResolutionService.cpp

@@ -0,0 +1,42 @@
+/**********************************************************************************
+ * MIT License
+ *
+ * Copyright (c) 2018 Antoine Beauchamp
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *********************************************************************************/
+
+#include "LegacyIconResolutionService.h"
+
+namespace shellanything
+{
+  LegacyIconResolutionService::LegacyIconResolutionService()
+  {
+  }
+
+  LegacyIconResolutionService::~LegacyIconResolutionService()
+  {
+  }
+
+  bool LegacyIconResolutionService::ResolveFileExtensionIcon(Icon& icon)
+  {
+    return false;
+  }
+
+} //namespace shellanything

src/windows/LegacyIconResolutionService.h

@@ -0,0 +1,59 @@
+/**********************************************************************************
+ * MIT License
+ *
+ * Copyright (c) 2018 Antoine Beauchamp
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *********************************************************************************/
+
+#ifndef SA_LEGACY_ICON_RESOLUTION_SERVICE_H
+#define SA_LEGACY_ICON_RESOLUTION_SERVICE_H
+
+#include "sa_windows_export.h"
+#include "IIconResolutionService.h"
+
+namespace shellanything
+{
+  /// <summary>
+  /// Legacy implementation class of IIconResolutionService that resolved by browsing Windows Registry.
+  /// </summary>
+  class SA_WINDOWS_EXPORT LegacyIconResolutionService : public virtual IIconResolutionService
+  {
+  public:
+    LegacyIconResolutionService();
+    virtual ~LegacyIconResolutionService();
+
+  private:
+    // Disable and copy constructor, dtor and copy operator
+    LegacyIconResolutionService(const LegacyIconResolutionService&);
+    LegacyIconResolutionService& operator=(const LegacyIconResolutionService&);
+  public:
+
+    /// <summary>
+    /// Resolve an icon's file extension to the system icon for this file extension.
+    /// </summary>
+    /// <param name="icon">The icon that have its fileextension's attribute set to resolve.</param>
+    /// <returns>Returns true if the operation is successful. Returns false otherwise.</returns>
+    virtual bool ResolveFileExtensionIcon(Icon& icon);
+
+  };
+
+} //namespace shellanything
+
+#endif //SA_LEGACY_ICON_RESOLUTION_SERVICE_H