/*
 *  Copyright 2019-2021 Diligent Graphics LLC
 *  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
 *  
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *  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
/// Defines Diligent::IFileStream interface

#include "Object.h"
#include "DataBlob.h"

DILIGENT_BEGIN_NAMESPACE(Diligent)

/// IFileStream interface unique identifier
// {E67F386C-6A5A-4A24-A0CE-C66435465D41}
static const struct INTERFACE_ID IID_FileStream =
    {0xe67f386c, 0x6a5a, 0x4a24, {0xa0, 0xce, 0xc6, 0x64, 0x35, 0x46, 0x5d, 0x41}};

// clang-format off

#define DILIGENT_INTERFACE_NAME IFileStream
#include "DefineInterfaceHelperMacros.h"

#define IFileStreamInclusiveMethods \
    IObjectInclusiveMethods;        \
    IFileStreamMethods FileStream

/// Base interface for a file stream
DILIGENT_BEGIN_INTERFACE(IFileStream, IObject)
{
    /// Reads data from the stream
    VIRTUAL bool METHOD(Read)(THIS_
                              void*  Data,
                              size_t BufferSize) PURE;

    VIRTUAL void METHOD(ReadBlob)(THIS_
                                  IDataBlob* pData) PURE;

    /// Writes data to the stream
    VIRTUAL bool METHOD(Write)(THIS_
                               const void* Data, 
                               size_t      Size) PURE;

    VIRTUAL size_t METHOD(GetSize)(THIS) PURE;

    VIRTUAL bool METHOD(IsValid)(THIS) PURE;
};
DILIGENT_END_INTERFACE

#include "UndefInterfaceHelperMacros.h"

#if DILIGENT_C_INTERFACE

// clang-format off

#    define IFileStream_Read(This, ...)     CALL_IFACE_METHOD(FileStream, Read,     This, __VA_ARGS__)
#    define IFileStream_ReadBlob(This, ...) CALL_IFACE_METHOD(FileStream, ReadBlob, This, __VA_ARGS__)
#    define IFileStream_Write(This, ...)    CALL_IFACE_METHOD(FileStream, Write,    This, __VA_ARGS__)
#    define IFileStream_GetSize(This)       CALL_IFACE_METHOD(FileStream, GetSize,  This)
#    define IFileStream_IsValid(This)       CALL_IFACE_METHOD(FileStream, IsValid,  This)

// clang-format on

#endif

DILIGENT_END_NAMESPACE // namespace Diligent