Made engine factory interfaces derived from IObject (fixed https://github.com/DiligentGraphics/DiligentCore/issues/72)

13 files changed, 209 insertions, 9 deletions

diff --git a/Graphics/GraphicsEngine/CMakeLists.txt b/Graphics/GraphicsEngine/CMakeLists.txt
index 25618d84..a458d2f3 100644
--- a/Graphics/GraphicsEngine/CMakeLists.txt
+++ b/Graphics/GraphicsEngine/CMakeLists.txt
@@ -9,6 +9,7 @@ set(INCLUDE
     include/Defines.h
     include/DeviceContextBase.h
     include/DeviceObjectBase.h
+    include/EngineFactoryBase.h
     include/EngineMemory.h
     include/FenceBase.h
     include/pch.h
diff --git a/Graphics/GraphicsEngine/include/EngineFactoryBase.h b/Graphics/GraphicsEngine/include/EngineFactoryBase.h
new file mode 100644
index 00000000..b22e174f
--- /dev/null
+++ b/Graphics/GraphicsEngine/include/EngineFactoryBase.h
@@ -0,0 +1,136 @@
+/*     Copyright 2015-2019 Egor Yusov
+ *  
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ * 
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ *  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 OF ANY PROPRIETARY RIGHTS.
+ *
+ *  In no event and under no legal theory, whether in tort (including negligence), 
+ *  contract, or otherwise, unless required by applicable law (such as deliberate 
+ *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
+ *  liable for any damages, including any direct, indirect, special, incidental, 
+ *  or consequential damages of any character arising as a result of this License or 
+ *  out of the use or inability to use the software (including but not limited to damages 
+ *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
+ *  all other commercial damages or losses), even if such Contributor has been advised 
+ *  of the possibility of such damages.
+ */
+
+#pragma once
+
+/// \file
+/// Implementation of the Diligent::EngineFactoryBase template class
+
+#include "Object.h"
+
+namespace Diligent
+{
+
+/// Template class implementing base functionality for an engine factory
+
+/// \tparam BaseInterface - base interface that this class will inheret
+///                         (Diligent::IEngineFactoryD3D11, Diligent::IEngineFactoryD3D12,
+///                          Diligent::IEngineFactoryVk or Diligent::IEngineFactoryOpenGL).
+template<class BaseInterface>
+class EngineFactoryBase : public BaseInterface
+{
+public:
+    using CounterValueType = IReferenceCounters::CounterValueType;
+
+    EngineFactoryBase(const INTERFACE_ID& FactoryIID)noexcept :
+        m_FactoryIID(FactoryIID),
+        m_RefCounters(*this)
+    {
+    }
+
+    virtual void QueryInterface(const INTERFACE_ID& IID, IObject** ppInterface)override final
+    {
+        if (ppInterface == nullptr)
+            return;
+
+        *ppInterface = nullptr;
+        if (IID == IID_Unknown || IID == m_FactoryIID)
+        {
+            *ppInterface = this;
+            (*ppInterface)->AddRef();
+        }
+    }
+
+    virtual CounterValueType AddRef()override final
+    {
+        return m_RefCounters.AddStrongRef();
+    }
+
+    virtual CounterValueType Release()override final
+    {
+        return m_RefCounters.ReleaseStrongRef();
+    }
+
+    virtual IReferenceCounters* GetReferenceCounters()const override final
+    {
+        return const_cast<IReferenceCounters*>(static_cast<const IReferenceCounters*>(&m_RefCounters));
+    }
+
+private:
+    class DummyReferenceCounters final : public IReferenceCounters
+    {
+    public:
+        DummyReferenceCounters(EngineFactoryBase& Factory)noexcept :
+            m_Factory(Factory)
+        {
+            m_lNumStrongReferences = 0;
+            m_lNumWeakReferences   = 0;
+        }
+
+        using IReferenceCounters::CounterValueType;
+        virtual CounterValueType AddStrongRef() override final
+        {
+            return Atomics::AtomicIncrement(m_lNumStrongReferences);
+        }
+
+        virtual CounterValueType ReleaseStrongRef()override final
+        {
+            return Atomics::AtomicDecrement(m_lNumStrongReferences);
+        }
+
+        virtual CounterValueType AddWeakRef()override final
+        {
+            return Atomics::AtomicIncrement(m_lNumWeakReferences);
+        }
+            
+        virtual CounterValueType ReleaseWeakRef()override final
+        {
+            return Atomics::AtomicDecrement(m_lNumWeakReferences);
+        }
+
+        virtual void GetObject(IObject** ppObject)override final
+        {
+            if (ppObject != nullptr)
+                m_Factory.QueryInterface(IID_Unknown, ppObject);
+        }
+
+        virtual CounterValueType GetNumStrongRefs()const override final
+        {
+            return m_lNumStrongReferences;
+        }
+
+        virtual CounterValueType GetNumWeakRefs()const override final
+        {
+            return m_lNumWeakReferences;
+        }
+    private:
+        EngineFactoryBase& m_Factory;
+        Atomics::AtomicLong m_lNumStrongReferences;
+        Atomics::AtomicLong m_lNumWeakReferences;
+    };
+
+    const INTERFACE_ID m_FactoryIID;
+    DummyReferenceCounters m_RefCounters;
+};
+
+}
diff --git a/Graphics/GraphicsEngineD3D11/interface/EngineFactoryD3D11.h b/Graphics/GraphicsEngineD3D11/interface/EngineFactoryD3D11.h
index dceab777..bfd94a98 100644
--- a/Graphics/GraphicsEngineD3D11/interface/EngineFactoryD3D11.h
+++ b/Graphics/GraphicsEngineD3D11/interface/EngineFactoryD3D11.h
@@ -28,6 +28,7 @@
 
 #include <sstream>
 
+#include "../../Primitives/interface/Object.h"
 #include "../../GraphicsEngine/interface/RenderDevice.h"
 #include "../../GraphicsEngine/interface/DeviceContext.h"
 #include "../../GraphicsEngine/interface/SwapChain.h"
@@ -39,7 +40,11 @@
 namespace Diligent
 {
 
-class IEngineFactoryD3D11
+// {62663A30-AAF0-4A9A-9729-9EAC6BF789F2}
+static const INTERFACE_ID IID_EngineFactoryD3D11 = 
+{ 0x62663a30, 0xaaf0, 0x4a9a, { 0x97, 0x29, 0x9e, 0xac, 0x6b, 0xf7, 0x89, 0xf2 } };
+
+class IEngineFactoryD3D11 : public IObject
 {
 public:
     virtual void CreateDeviceAndContextsD3D11(const EngineD3D11CreateInfo& EngineCI, 
diff --git a/Graphics/GraphicsEngineD3D11/src/EngineFactoryD3D11.cpp b/Graphics/GraphicsEngineD3D11/src/EngineFactoryD3D11.cpp
index d69a94ee..3da158e6 100644
--- a/Graphics/GraphicsEngineD3D11/src/EngineFactoryD3D11.cpp
+++ b/Graphics/GraphicsEngineD3D11/src/EngineFactoryD3D11.cpp
@@ -47,6 +47,12 @@ public:
         static EngineFactoryD3D11Impl TheFactory;
         return &TheFactory;
     }
+    
+    using TBase = EngineFactoryD3DBase<IEngineFactoryD3D11, DeviceType::D3D11>;
+
+    EngineFactoryD3D11Impl() :
+        TBase(IID_EngineFactoryD3D11)
+    {}
 
     void CreateDeviceAndContextsD3D11(const EngineD3D11CreateInfo& EngineCI, 
                                       IRenderDevice**              ppDevice, 
diff --git a/Graphics/GraphicsEngineD3D12/interface/EngineFactoryD3D12.h b/Graphics/GraphicsEngineD3D12/interface/EngineFactoryD3D12.h
index 7ac6e9e0..03b636ff 100644
--- a/Graphics/GraphicsEngineD3D12/interface/EngineFactoryD3D12.h
+++ b/Graphics/GraphicsEngineD3D12/interface/EngineFactoryD3D12.h
@@ -28,6 +28,7 @@
 
 #include <sstream>
 
+#include "../../Primitives/interface/Object.h"
 #include "../../GraphicsEngine/interface/RenderDevice.h"
 #include "../../GraphicsEngine/interface/DeviceContext.h"
 #include "../../GraphicsEngine/interface/SwapChain.h"
@@ -39,7 +40,11 @@
 namespace Diligent
 {
 
-class IEngineFactoryD3D12
+// {72BD38B0-684A-4889-9C68-0A80EC802DDE}
+static const INTERFACE_ID IID_EngineFactoryD3D12 = 
+{ 0x72bd38b0, 0x684a, 0x4889, { 0x9c, 0x68, 0xa, 0x80, 0xec, 0x80, 0x2d, 0xde } };
+
+class IEngineFactoryD3D12 : public IObject
 {
 public:
     virtual void CreateDeviceAndContextsD3D12(const EngineD3D12CreateInfo& EngineCI, 
diff --git a/Graphics/GraphicsEngineD3D12/src/EngineFactoryD3D12.cpp b/Graphics/GraphicsEngineD3D12/src/EngineFactoryD3D12.cpp
index 18a69020..36a2c29c 100644
--- a/Graphics/GraphicsEngineD3D12/src/EngineFactoryD3D12.cpp
+++ b/Graphics/GraphicsEngineD3D12/src/EngineFactoryD3D12.cpp
@@ -51,6 +51,12 @@ public:
         return &TheFactory;
     }
 
+    using TBase = EngineFactoryD3DBase<IEngineFactoryD3D12, DeviceType::D3D12>;
+
+    EngineFactoryD3D12Impl() :
+        TBase(IID_EngineFactoryD3D12)
+    {}
+
     void CreateDeviceAndContextsD3D12(const EngineD3D12CreateInfo& EngineCI, 
                                       IRenderDevice**              ppDevice, 
                                       IDeviceContext**             ppContexts,
diff --git a/Graphics/GraphicsEngineD3DBase/include/EngineFactoryD3DBase.h b/Graphics/GraphicsEngineD3DBase/include/EngineFactoryD3DBase.h
index 61ef2eda..ea0de389 100644
--- a/Graphics/GraphicsEngineD3DBase/include/EngineFactoryD3DBase.h
+++ b/Graphics/GraphicsEngineD3DBase/include/EngineFactoryD3DBase.h
@@ -24,6 +24,7 @@
 #pragma once
 
 #include "DXGITypeConversions.h"
+#include "EngineFactoryBase.h"
 
 /// \file
 /// Implementation of the Diligent::EngineFactoryD3DBase template class
@@ -32,9 +33,15 @@ namespace Diligent
 {
 
 template<typename BaseInterface, DeviceType DevType>
-class EngineFactoryD3DBase : public BaseInterface
+class EngineFactoryD3DBase : public EngineFactoryBase<BaseInterface>
 {
 public:
+    using TEngineFactoryBase = EngineFactoryBase<BaseInterface>;
+
+    EngineFactoryD3DBase(const INTERFACE_ID& FactoryIID) : 
+        TEngineFactoryBase(FactoryIID)
+    {}
+
     /// Enumerates hardware adapters available on this machine
 
     /// \param [in,out] NumAdapters - Number of adapters. If Adapters is null, this value
diff --git a/Graphics/GraphicsEngineMetal/interface/EngineFactoryMtl.h b/Graphics/GraphicsEngineMetal/interface/EngineFactoryMtl.h
index ca6088b6..225d1152 100644
--- a/Graphics/GraphicsEngineMetal/interface/EngineFactoryMtl.h
+++ b/Graphics/GraphicsEngineMetal/interface/EngineFactoryMtl.h
@@ -28,6 +28,7 @@
 
 #include <sstream>
 
+#include "../../Primitives/interface/Object.h"
 #include "../../GraphicsEngine/interface/RenderDevice.h"
 #include "../../GraphicsEngine/interface/DeviceContext.h"
 #include "../../GraphicsEngine/interface/SwapChain.h"
@@ -38,7 +39,11 @@
 namespace Diligent
 {
 
-class IEngineFactoryMtl
+// {CF4A590D-2E40-4F48-9579-0D25991F963B}
+static const INTERFACE_ID IID_EngineFactoryMtl = 
+{ 0xcf4a590d, 0x2e40, 0x4f48, { 0x95, 0x79, 0xd, 0x25, 0x99, 0x1f, 0x96, 0x3b } };
+
+class IEngineFactoryMtl : public IObject
 {
 public:
     virtual void CreateDeviceAndContextsMtl(const EngineMtlCreateInfo& Attribs, 
diff --git a/Graphics/GraphicsEngineMetal/src/EngineFactoryMtl.mm b/Graphics/GraphicsEngineMetal/src/EngineFactoryMtl.mm
index 7516d45e..0aa1edf7 100644
--- a/Graphics/GraphicsEngineMetal/src/EngineFactoryMtl.mm
+++ b/Graphics/GraphicsEngineMetal/src/EngineFactoryMtl.mm
@@ -30,12 +30,13 @@
 #include "SwapChainMtlImpl.h"
 #include "MtlTypeConversions.h"
 #include "EngineMemory.h"
+#include "EngineFactoryBase.h"
 
 namespace Diligent
 {
 
 /// Engine factory for Mtl implementation
-class EngineFactoryMtlImpl : public IEngineFactoryMtl
+class EngineFactoryMtlImpl : public EngineFactoryBase<IEngineFactoryMtl>
 {
 public:
     static EngineFactoryMtlImpl* GetInstance()
@@ -44,6 +45,11 @@ public:
         return &TheFactory;
     }
 
+    using TBase = EngineFactoryBase<IEngineFactoryMtl>;
+    EngineFactoryMtlImpl() :
+        TBase(IID_EngineFactoryMtl)
+    {}
+
     void CreateDeviceAndContextsMtl(const EngineMtlCreateInfo&  EngineAttribs, 
                                     IRenderDevice**             ppDevice, 
                                     IDeviceContext**            ppContexts,
diff --git a/Graphics/GraphicsEngineOpenGL/interface/EngineFactoryOpenGL.h b/Graphics/GraphicsEngineOpenGL/interface/EngineFactoryOpenGL.h
index 63627856..2ad18b7a 100644
--- a/Graphics/GraphicsEngineOpenGL/interface/EngineFactoryOpenGL.h
+++ b/Graphics/GraphicsEngineOpenGL/interface/EngineFactoryOpenGL.h
@@ -28,6 +28,7 @@
 
 #include <sstream>
 
+#include "../../Primitives/interface/Object.h"
 #include "../../GraphicsEngine/interface/RenderDevice.h"
 #include "../../GraphicsEngine/interface/DeviceContext.h"
 #include "../../GraphicsEngine/interface/SwapChain.h"
@@ -51,7 +52,11 @@
 namespace Diligent
 {
 
-class IEngineFactoryOpenGL
+// {9BAAC767-02CC-4FFA-9E4B-E1340F572C49}
+static const INTERFACE_ID IID_EngineFactoryOpenGL = 
+{ 0x9baac767, 0x2cc, 0x4ffa, { 0x9e, 0x4b, 0xe1, 0x34, 0xf, 0x57, 0x2c, 0x49 } };
+
+class IEngineFactoryOpenGL : public IObject
 {
 public:
     virtual void CreateDeviceAndSwapChainGL(const EngineGLCreateInfo& EngineCI,
diff --git a/Graphics/GraphicsEngineOpenGL/src/EngineFactoryOpenGL.cpp b/Graphics/GraphicsEngineOpenGL/src/EngineFactoryOpenGL.cpp
index 0b376f0c..18f08312 100644
--- a/Graphics/GraphicsEngineOpenGL/src/EngineFactoryOpenGL.cpp
+++ b/Graphics/GraphicsEngineOpenGL/src/EngineFactoryOpenGL.cpp
@@ -30,6 +30,7 @@
 #include "DeviceContextGLImpl.h"
 #include "EngineMemory.h"
 #include "HLSL2GLSLConverterObject.h"
+#include "EngineFactoryBase.h"
 
 #if PLATFORM_IOS
 #   include "SwapChainGLIOS.h"
@@ -58,15 +59,21 @@ namespace Diligent
 #endif
 
 /// Engine factory for OpenGL implementation
-class EngineFactoryOpenGLImpl : public IEngineFactoryOpenGL
+class EngineFactoryOpenGLImpl : public EngineFactoryBase<IEngineFactoryOpenGL>
 {
 public:
+
     static EngineFactoryOpenGLImpl* GetInstance()
     {
         static EngineFactoryOpenGLImpl TheFactory;
         return &TheFactory;
     }
 
+    using TBase = EngineFactoryBase<IEngineFactoryOpenGL>;
+    EngineFactoryOpenGLImpl() :
+        TBase(IID_EngineFactoryOpenGL)
+    {}
+
     virtual void CreateDeviceAndSwapChainGL(const EngineGLCreateInfo& EngineCI,
                                             IRenderDevice**           ppDevice,
                                             IDeviceContext**          ppImmediateContext,
diff --git a/Graphics/GraphicsEngineVulkan/interface/EngineFactoryVk.h b/Graphics/GraphicsEngineVulkan/interface/EngineFactoryVk.h
index 861f5514..4e986054 100644
--- a/Graphics/GraphicsEngineVulkan/interface/EngineFactoryVk.h
+++ b/Graphics/GraphicsEngineVulkan/interface/EngineFactoryVk.h
@@ -28,6 +28,7 @@
 
 #include <sstream>
 
+#include "../../Primitives/interface/Object.h"
 #include "../../GraphicsEngine/interface/RenderDevice.h"
 #include "../../GraphicsEngine/interface/DeviceContext.h"
 #include "../../GraphicsEngine/interface/SwapChain.h"
@@ -48,7 +49,11 @@
 namespace Diligent
 {
 
-class IEngineFactoryVk
+// {F554EEE4-57C2-4637-A508-85BE80DC657C}
+static const INTERFACE_ID IID_EngineFactoryVk = 
+{ 0xf554eee4, 0x57c2, 0x4637, { 0xa5, 0x8, 0x85, 0xbe, 0x80, 0xdc, 0x65, 0x7c } };
+
+class IEngineFactoryVk : public IObject
 {
 public:
     virtual void CreateDeviceAndContextsVk(const EngineVkCreateInfo& EngineCI,
diff --git a/Graphics/GraphicsEngineVulkan/src/EngineFactoryVk.cpp b/Graphics/GraphicsEngineVulkan/src/EngineFactoryVk.cpp
index acb6265a..4014e6b6 100644
--- a/Graphics/GraphicsEngineVulkan/src/EngineFactoryVk.cpp
+++ b/Graphics/GraphicsEngineVulkan/src/EngineFactoryVk.cpp
@@ -34,12 +34,13 @@
 #include "CommandQueueVkImpl.h"
 #include "VulkanUtilities/VulkanInstance.h"
 #include "VulkanUtilities/VulkanPhysicalDevice.h"
+#include "EngineFactoryBase.h"
 
 namespace Diligent
 {
 
 /// Engine factory for Vk implementation
-class EngineFactoryVkImpl : public IEngineFactoryVk
+class EngineFactoryVkImpl : public EngineFactoryBase<IEngineFactoryVk>
 {
 public:
     static EngineFactoryVkImpl* GetInstance()
@@ -48,6 +49,11 @@ public:
         return &TheFactory;
     }
 
+    using TBase = EngineFactoryBase<IEngineFactoryVk>;
+    EngineFactoryVkImpl() :
+        TBase(IID_EngineFactoryVk)
+    {}
+
     void CreateDeviceAndContextsVk(const EngineVkCreateInfo& EngineCI, 
                                    IRenderDevice**           ppDevice, 
                                    IDeviceContext**          ppContexts,