FileSystem.h

// Copyright (c) 2016-2018 Kiwano - Nomango
//
// 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.
 
#pragma once
#include <kiwano/core/Resource.h>
 
namespace kiwano
{
class KGE_API FileSystem : public Singleton<FileSystem>
{
    friend Singleton<FileSystem>;
 
public:
    void AddSearchPath(StringView path);
 
    void SetSearchPaths(const Vector<String>& paths);
 
    String GetFullPathForFile(StringView file) const;
 
    String GetFileExt(StringView file) const;
 
    void AddFileLookupRule(StringView key, StringView file_path);
 
    void SetFileLookupDictionary(const UnorderedMap<String, String>& dict);
 
    void ReadFile(StringView file_path, std::vector<uint8_t>& output);
 
    bool IsFileExists(StringView file_path) const;
 
    bool IsAbsolutePath(StringView path) const;
 
    bool RemoveFile(StringView file_path) const;
 
    bool ExtractResourceToFile(const Resource& res, StringView dest_file_name) const;
 
    ~FileSystem();
 
private:
    FileSystem();
 
private:
    Vector<String>                       search_paths_;
    UnorderedMap<String, String>         file_lookup_dict_;
    mutable UnorderedMap<String, String> file_lookup_cache_;
};
}  // namespace kiwano