FileSystem.hpp

Go to the documentation of this file.

/**********************************************************************************/
/* This file is part of Berserk Engine project                                    */
/* https://github.com/EgorOrachyov/Berserk                                        */
/**********************************************************************************/
/* MIT License                                                                    */
/*                                                                                */
/* Copyright (c) 2018 - 2021 Egor Orachyov                                        */
/*                                                                                */
/* Permission is hereby granted, free of charge, to any person obtaining a copy   */
/* of this software and associated documentation files (the "Software"), to deal  */
/* in the Software without restriction, including without limitation the rights   */
/* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell      */
/* copies of the Software, and to permit persons to whom the Software is          */
/* furnished to do so, subject to the following conditions:                       */
/*                                                                                */
/* The above copyright notice and this permission notice shall be included in all */
/* copies or substantial portions of the Software.                                */
/*                                                                                */
/* 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. IN NO EVENT SHALL THE    */
/* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER         */
/* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,  */
/* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE  */
/* SOFTWARE.                                                                      */
/**********************************************************************************/
 
#ifndef BERSERK_FILESYSTEM_HPP
#define BERSERK_FILESYSTEM_HPP
 
#include <core/Config.hpp>
#include <core/Data.hpp>
#include <core/Typedefs.hpp>
#include <core/string/String.hpp>
#include <core/templates/Ref.hpp>
 
#include <cstdio>
#include <mutex>
#include <unordered_map>
#include <vector>
 
BRK_NS_BEGIN
 
class FileSystem final {
public:
    enum class EntryType {
        File,
        Directory,
        Link,
        Unknown
    };
 
    struct Entry {
        String name;
        EntryType type;
    };
 
    BRK_API FileSystem();
    BRK_API ~FileSystem() = default;
 
    BRK_API std::FILE *OpenFile(const String &filepath, const String &mode);
 
    BRK_API void CloseFile(std::FILE *file);
 
    BRK_API Ref<Data> ReadFile(const String &filepath);
 
    BRK_API void AddSearchPath(String path);
 
    BRK_API void SetSearchPaths(std::vector<String> searchPaths);
 
    BRK_API String GetFullFilePath(const String &filename);
 
    BRK_API String GetFullDirPath(const String &dirname);
 
    BRK_API String GetFileExtension(const String &filename);
 
    BRK_API String GetFileName(const String &filename, bool withoutExtension = false);
 
    BRK_API bool IsAbsolutePath(const String &filename);
 
    BRK_API bool IsFileExists(const String &filename);
 
    BRK_API bool IsDirExists(const String &dirname);
 
    BRK_API std::vector<Entry> ListDir(const String &dir);
 
    BRK_API const String &GetExecutablePath();
 
    BRK_API String GetExecutableDir() const;
 
private:
    void Init();
    void ClearCache();
    bool IsFileExistsAbs(const String &filename);
    bool IsDirExistsAbs(const String &dirname);
    String ResolveFilePath(const String &prefix, const String &file);
    String ResolveDirPath(const String &prefix, const String &dir);
    String GetPathForFile(const String &path, const String &filename);
 
    std::vector<String> mSearchPaths;
 
    std::unordered_map<String, String> mCachedFullFilePath;
 
    std::unordered_map<String, String> mCachedFullDirPath;
 
    String mExecutablePath;
 
    mutable std::recursive_mutex mMutex;
};
 
BRK_NS_END
 
#endif//BERSERK_FILESYSTEM_HPP