Win32FileSystem.hpp

Go to the documentation of this file.

/*
 *  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
 
#include <memory>
#include "../../Basic/interface/BasicFileSystem.hpp"
#include "../../Basic/interface/StandardFile.hpp"
#include "../../../Primitives/interface/FlagEnum.h"
 
class WindowsFile : public StandardFile
{
public:
    WindowsFile(const FileOpenAttribs& OpenAttribs);
};
 
enum FILE_DIALOG_FLAGS : Diligent::Uint32
{
    FILE_DIALOG_FLAG_NONE = 0x000,
 
    FILE_DIALOG_FLAG_DONT_ADD_TO_RECENT = 0x001,
 
    FILE_DIALOG_FLAG_FILE_MUST_EXIST = 0x002,
 
    FILE_DIALOG_FLAG_NO_CHANGE_DIR = 0x004,
 
    FILE_DIALOG_FLAG_OVERWRITE_PROMPT = 0x008
};
DEFINE_FLAG_ENUM_OPERATORS(FILE_DIALOG_FLAGS);
 
enum FILE_DIALOG_TYPE : Diligent::Uint32
{
    FILE_DIALOG_TYPE_OPEN,
    FILE_DIALOG_TYPE_SAVE
};
 
struct FileDialogAttribs
{
    FILE_DIALOG_TYPE  Type  = FILE_DIALOG_TYPE_OPEN;
    FILE_DIALOG_FLAGS Flags = FILE_DIALOG_FLAG_NONE;
 
    const char* Title  = nullptr;
    const char* Filter = nullptr;
 
    FileDialogAttribs() noexcept {}
 
    explicit FileDialogAttribs(FILE_DIALOG_TYPE _Type) noexcept :
        Type{_Type}
    {
        switch (Type)
        {
            case FILE_DIALOG_TYPE_OPEN:
                Flags = FILE_DIALOG_FLAG_DONT_ADD_TO_RECENT | FILE_DIALOG_FLAG_FILE_MUST_EXIST | FILE_DIALOG_FLAG_NO_CHANGE_DIR;
                break;
 
            case FILE_DIALOG_TYPE_SAVE:
                Flags = FILE_DIALOG_FLAG_DONT_ADD_TO_RECENT | FILE_DIALOG_FLAG_OVERWRITE_PROMPT | FILE_DIALOG_FLAG_NO_CHANGE_DIR;
                break;
        }
    }
};
 
struct WindowsFileSystem : public BasicFileSystem
{
public:
    static WindowsFile* OpenFile(const FileOpenAttribs& OpenAttribs);
 
    static inline Diligent::Char GetSlashSymbol() { return '\\'; }
 
    static bool FileExists(const Diligent::Char* strFilePath);
    static bool PathExists(const Diligent::Char* strPath);
 
    static bool CreateDirectory(const Diligent::Char* strPath);
    static void ClearDirectory(const Diligent::Char* strPath, bool Recursive = false);
    static void DeleteFile(const Diligent::Char* strPath);
    static void DeleteDirectory(const Diligent::Char* strPath);
    static bool IsDirectory(const Diligent::Char* strPath);
 
    static std::vector<std::unique_ptr<FindFileData>> Search(const Diligent::Char* SearchPattern);
 
    static std::string FileDialog(const FileDialogAttribs& DialogAttribs);
 
    static std::string GetCurrentDirectory();
 
 
 
    static bool GetRelativePath(const Diligent::Char* strPathFrom,
                                bool                  IsFromDirectory,
                                const Diligent::Char* strPathTo,
                                bool                  IsToDirectory,
                                std::string&          RelativePath);
};