BasicFileSystem.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 <vector>
#include "BasicTypes.h"

enum class EFileAccessMode
{
    Read,
    Overwrite,
    Append
};

enum class FilePosOrigin
{
    Start,
    Curr,
    End
};


struct FileOpenAttribs
{
    const Diligent::Char *strFilePath;
    EFileAccessMode AccessMode;
    FileOpenAttribs(const Diligent::Char *Path = nullptr, 
                     EFileAccessMode Access = EFileAccessMode::Read) :
        strFilePath( Path ),
        AccessMode( Access )
    {}
};

class BasicFile
{
public:
    BasicFile( const FileOpenAttribs &OpenAttribs, Diligent::Char SlashSymbol );
    virtual ~BasicFile();

    size_t GetSize();

    const Diligent::String& GetPath(){ return m_Path; }
    
protected:
    Diligent::String GetOpenModeStr();

    FileOpenAttribs m_OpenAttribs;
    Diligent::String m_Path;
};

struct FindFileData
{
    virtual const Diligent::Char* Name()const = 0;
    virtual bool IsDirectory()const = 0;

    virtual ~FindFileData(){}
};

struct BasicFileSystem
{
public:
    static BasicFile* OpenFile( FileOpenAttribs &OpenAttribs );
    static void ReleaseFile( BasicFile* );

    static std::string GetFullPath( const Diligent::Char *strFilePath );

    static bool FileExists( const Diligent::Char *strFilePath );

    static void SetWorkingDirectory( const Diligent::Char *strWorkingDir ){ m_strWorkingDirectory = strWorkingDir; }
    static const Diligent::String &GetWorkingDirectory(){ return m_strWorkingDirectory; }

    static Diligent::Char GetSlashSymbol();
    static void CorrectSlashes(Diligent::String &Path, Diligent::Char SlashSymbol);
    
    static void SplitFilePath(const Diligent::String& FullName,
                              Diligent::String *Path, 
                              Diligent::String *Name);

protected:
    static Diligent::String m_strWorkingDirectory;
};