DeviceObjectBase.h

/*     Copyright 2015-2018 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


#include "ObjectBase.h"
#include "UniqueIdentifier.h"

namespace Diligent
{
   
template<typename BaseInterface>
class RenderDeviceBase;

class IRenderDevice;

template<class BaseInterface, typename ObjectDescType>
class DeviceObjectBase : public ObjectBase<BaseInterface>
{
public:
    typedef ObjectBase<BaseInterface> TBase;

    DeviceObjectBase( IReferenceCounters *pRefCounters,
                      IRenderDevice *pDevice,
                      const ObjectDescType &ObjDesc,
                      bool bIsDeviceInternal = false) :
        TBase(pRefCounters),
        m_pDevice( pDevice ),
        // Do not keep strong reference to the device if the object is an internal device object
        m_spDevice( bIsDeviceInternal ? nullptr : pDevice ),
        m_ObjectNameCopy(ObjDesc.Name ? ObjDesc.Name : ""),
        m_Desc( ObjDesc )
    {
        m_Desc.Name = m_ObjectNameCopy.c_str();

        //                        !!!WARNING!!!
        // We cannot add resource to the hash table from here, because the object
        // has not been completely created yet and the reference counters object
        // is not initialized!
        //m_pDevice->AddResourceToHash( this ); - ERROR!
    }

    DeviceObjectBase( const DeviceObjectBase&  ) = delete;
    DeviceObjectBase(       DeviceObjectBase&& ) = delete;
    DeviceObjectBase& operator = ( const DeviceObjectBase&  ) = delete;
    DeviceObjectBase& operator = (       DeviceObjectBase&& ) = delete;

    virtual ~DeviceObjectBase()
    {
    }

    inline virtual Atomics::Long Release()override final
    {
        // Render device owns allocators for all types of device objects,
        // so it must be destroyed after all device objects are released. 
        // Consider the following scenario: an object A ownes last strong 
        // reference to the device:
        // 
        // 1. A::~A() completes
        // 2. A::~DeviceObjectBase() completes
        // 3. A::m_spDevice is released
        //       Render device is destroyed, all allocators are invalid
        // 4. RefCountersImpl::ObjectWrapperBase::DestroyObject() calls 
        //    m_pAllocator->Free(m_pObject) - crash!
         
        // We must keep the device alive while the object is being destroyed
        RefCntAutoPtr<IRenderDevice> pDevice(m_spDevice);
        // Note that internal device object do not keep strong reference to the device
        return TBase::Release();
    }

    IMPLEMENT_QUERY_INTERFACE_IN_PLACE( IID_DeviceObject, TBase )

    virtual const ObjectDescType& GetDesc()const override final
    {
        return m_Desc;
    }

    UniqueIdentifier GetUniqueID()const
    {
        return m_UniqueID.GetID();
    }

    IRenderDevice *GetDevice()const{return m_pDevice;}

private:
    RefCntAutoPtr<IRenderDevice> m_spDevice;

    IRenderDevice *m_pDevice;

protected:
    

    const String m_ObjectNameCopy;

    ObjectDescType m_Desc;
    
    // Template argument is only used to separate counters for 
    // different groups of objects
    UniqueIdHelper<BaseInterface> m_UniqueID;
};

}