/*     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
/// Declaration of Diligent::BufferVkImpl class

#include "BufferVk.h"
#include "RenderDeviceVk.h"
#include "BufferBase.h"
#include "BufferViewVkImpl.h"
#include "VulkanDynamicHeap.h"
#include "VulkanUtilities/VulkanObjectWrappers.h"
#include "VulkanUtilities/VulkanMemoryManager.h"
#include "VulkanDynamicHeap.h"
#include "STDAllocator.h"
#include "RenderDeviceVkImpl.h"

namespace Diligent
{

class FixedBlockMemoryAllocator;
class DeviceContextVkImpl;

/// Implementation of the Diligent::IBufferVk interface
class BufferVkImpl final : public BufferBase<IBufferVk, RenderDeviceVkImpl, BufferViewVkImpl, FixedBlockMemoryAllocator>
{
public:
    using TBufferBase = BufferBase<IBufferVk, RenderDeviceVkImpl, BufferViewVkImpl, FixedBlockMemoryAllocator>;

    BufferVkImpl(IReferenceCounters*        pRefCounters, 
                 FixedBlockMemoryAllocator& BuffViewObjMemAllocator, 
                 RenderDeviceVkImpl*        pDeviceVk, 
                 const BufferDesc&          BuffDesc, 
                 const BufferData*          pBuffData = nullptr);

    BufferVkImpl(IReferenceCounters*        pRefCounters, 
                 FixedBlockMemoryAllocator& BuffViewObjMemAllocator, 
                 class RenderDeviceVkImpl*  pDeviceVk, 
                 const BufferDesc&          BuffDesc, 
                 RESOURCE_STATE             InitialState,
                 VkBuffer                   vkBuffer);
    ~BufferVkImpl();

    virtual void QueryInterface(const INTERFACE_ID& IID, IObject** ppInterface)override;

#ifdef DEVELOPMENT
    void DvpVerifyDynamicAllocation(DeviceContextVkImpl* pCtx)const;
#endif

    Uint32 GetDynamicOffset(Uint32 CtxId, DeviceContextVkImpl* pCtx)const
    {
        if(m_VulkanBuffer != VK_NULL_HANDLE)
        {
            return 0;
        }
        else
        {
            VERIFY(m_Desc.Usage == USAGE_DYNAMIC, "Dynamic buffer is expected");
            VERIFY_EXPR(!m_DynamicAllocations.empty());
#ifdef DEVELOPMENT
            DvpVerifyDynamicAllocation(pCtx);
#endif
            auto& DynAlloc = m_DynamicAllocations[CtxId];
            return static_cast<Uint32>(DynAlloc.AlignedOffset);
        }
    }
    VkBuffer GetVkBuffer()const override final;

    virtual void* GetNativeHandle()override final
    { 
        auto vkBuffer = GetVkBuffer(); 
        return vkBuffer;
    }

    virtual void SetAccessFlags(VkAccessFlags AccessFlags)override final;
    virtual VkAccessFlags GetAccessFlags()const override final;
    bool CheckAccessFlags(VkAccessFlags AccessFlags)const
    {
        return (GetAccessFlags() & AccessFlags) == AccessFlags;
    }

private:
    friend class DeviceContextVkImpl;

    virtual void CreateViewInternal(const struct BufferViewDesc& ViewDesc, IBufferView** ppView, bool bIsDefaultView)override;

    VulkanUtilities::BufferViewWrapper CreateView(struct BufferViewDesc &ViewDesc);
    Uint32        m_DynamicOffsetAlignment = 0;

    std::vector<VulkanDynamicAllocation, STDAllocatorRawMem<VulkanDynamicAllocation> > m_DynamicAllocations;

    VulkanUtilities::BufferWrapper          m_VulkanBuffer;
    VulkanUtilities::VulkanMemoryAllocation m_MemoryAllocation;
};

}
