Magic_Game/src/kiwano/platform/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
{
	/**
	* \~chinese
	* @brief <EFBFBD>ļ<EFBFBD>ϵͳ<EFBFBD><EFBFBD>Ϊ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ģ<EFBFBD><EFBFBD><EFBFBD>ṩ<EFBFBD>ļ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
	*/
	class KGE_API FileSystem
		: public Singleton<FileSystem>
	{
		friend Singleton<FileSystem>;

	public:
		/**
		* \~chinese
		* @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ļ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>·<EFBFBD><EFBFBD>
		* @param path <EFBFBD>ļ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>·<EFBFBD><EFBFBD>
		*/
		void AddSearchPath(String const& path);

		/**
		* \~chinese
		* @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ļ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>·<EFBFBD><EFBFBD>
		* @param paths <EFBFBD><EFBFBD><EFBFBD><EFBFBD>·<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
		*/
		void SetSearchPaths(Vector<String> const& paths);

		/**
		* \~chinese
		* @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>б<EFBFBD><EFBFBD>в<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ļ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ȡ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>·<EFBFBD><EFBFBD>
		* @param file <EFBFBD>ļ<EFBFBD>·<EFBFBD><EFBFBD>
		* @return <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ļ<EFBFBD>·<EFBFBD><EFBFBD>
		*/
		String GetFullPathForFile(String const& file) const;

		/**
		* \~chinese
		* @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ļ<EFBFBD>·<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ֵ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
		* @param key <EFBFBD>ļ<EFBFBD><EFBFBD>ؼ<EFBFBD><EFBFBD><EFBFBD>
		* @param file_path <EFBFBD>ļ<EFBFBD>·<EFBFBD><EFBFBD>
		*/
		void AddFileLookupRule(String const& key, String const& file_path);

		/**
		* \~chinese
		* @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ļ<EFBFBD>·<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ֵ<EFBFBD>
		* @param dict <EFBFBD>ļ<EFBFBD>·<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ֵ<EFBFBD>
		*/
		void SetFileLookupDictionary(UnorderedMap<String, String> const& dict);

		/**
		* \~chinese
		* @brief <EFBFBD>ļ<EFBFBD><EFBFBD>Ƿ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
		* @param file_path <EFBFBD>ļ<EFBFBD>·<EFBFBD><EFBFBD>
		* @return <EFBFBD><EFBFBD><EFBFBD>ļ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ڣ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> true
		*/
		bool IsFileExists(String const& file_path) const;

		/**
		* \~chinese
		* @brief <EFBFBD>ж<EFBFBD>·<EFBFBD><EFBFBD><EFBFBD>Ƿ<EFBFBD><EFBFBD>Ǿ<EFBFBD><EFBFBD><EFBFBD>·<EFBFBD><EFBFBD>
		* @param path <EFBFBD>ļ<EFBFBD>·<EFBFBD><EFBFBD>
		* @return <EFBFBD><EFBFBD><EFBFBD>Ǿ<EFBFBD><EFBFBD><EFBFBD>·<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> true
		*/
		bool IsAbsolutePath(String const& path) const;

		/**
		* \~chinese
		* @brief ɾ<EFBFBD><EFBFBD><EFBFBD>ļ<EFBFBD>
		* @param file_path <EFBFBD>ļ<EFBFBD>·<EFBFBD><EFBFBD>
		* @return ɾ<EFBFBD><EFBFBD><EFBFBD>Ƿ<EFBFBD><EFBFBD>ɹ<EFBFBD>
		*/
		bool RemoveFile(String const& file_path) const;

		/**
		* \~chinese
		* @brief <EFBFBD>ͷŶ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Դ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʱ<EFBFBD>ļ<EFBFBD>Ŀ¼
		* @param res <EFBFBD><EFBFBD>Դ
		* @param dest_file_name Ŀ<EFBFBD><EFBFBD><EFBFBD>ļ<EFBFBD><EFBFBD><EFBFBD>
		* @return <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƿ<EFBFBD><EFBFBD>ɹ<EFBFBD>
		*/
		bool ExtractResourceToFile(
			Resource const& res,
			String const& dest_file_name
		) const;

	private:
		FileSystem();

		~FileSystem();

	private:
		Vector<String> search_paths_;
		UnorderedMap<String, String> file_lookup_dict_;
		mutable UnorderedMap<String, String> file_lookup_cache_;
	};
}