anki-3d-engine/AnKi/Resource/ResourceFilesystem.h

// Copyright (C) 2009-present, Panagiotis Christopoulos Charitos and contributors.
// All rights reserved.
// Code licensed under the BSD License.
// http://www.anki3d.org/LICENSE

#pragma once

#include <AnKi/Resource/Common.h>
#include <AnKi/Util/String.h>
#include <AnKi/Util/StringList.h>
#include <AnKi/Util/File.h>
#include <AnKi/Util/Ptr.h>
#include <AnKi/Util/CVarSet.h>

namespace anki {

ANKI_CVAR(StringCVar, Rsrc, DataPaths, ".",
		  "The engine loads assets only in from these paths. Separate them with : (it's smart enough to identify drive letters in Windows). After a "
		  "path you can add an optional | and what follows it is a number of words to include or exclude paths. eg. "
		  "my_path|include_this,include_that,!exclude_this")

// Resource filesystem file. An interface that abstracts the resource file.
class ResourceFile
{
public:
	ResourceFile() = default;

	ResourceFile(const ResourceFile&) = delete; // Non-copyable

	virtual ~ResourceFile()
	{
	}

	ResourceFile& operator=(const ResourceFile&) = delete; // Non-copyable

	// Read data from the file
	virtual Error read(void* buff, PtrSize size) = 0;

	// Read all the contents of a text file. If the file is not rewined it will probably fail
	virtual Error readAllText(ResourceString& out) = 0;

	// Read 32bit unsigned integer. Set the endianness if the file's endianness is different from the machine's
	virtual Error readU32(U32& u) = 0;

	// Read 32bit float. Set the endianness if the file's endianness is different from the machine's
	virtual Error readF32(F32& f) = 0;

	// Set the position indicator to a new position
	// offset: Number of bytes to offset from origin
	// origin: Position used as reference for the offset
	virtual Error seek(PtrSize offset, FileSeekOrigin origin) = 0;

	// Get the size of the file.
	virtual PtrSize getSize() const = 0;

	void retain() const
	{
		m_refcount.fetchAdd(1);
	}

	I32 release() const
	{
		return m_refcount.fetchSub(1);
	}

private:
	mutable Atomic<I32> m_refcount = {0};
};

// Resource file smart pointer.
class ResourceFileDeleter
{
public:
	void operator()(ResourceFile* x)
	{
		deleteInstance(ResourceMemoryPool::getSingleton(), x);
	}
};

using ResourceFilePtr = IntrusivePtr<ResourceFile, ResourceFileDeleter>;

// Resource filesystem.
class ResourceFilesystem : public MakeSingleton<ResourceFilesystem>
{
public:
	ResourceFilesystem() = default;

	ResourceFilesystem(const ResourceFilesystem&) = delete; // Non-copyable

	~ResourceFilesystem();

	ResourceFilesystem& operator=(const ResourceFilesystem&) = delete; // Non-copyable

	Error init();

	// Search the path list to find the file. Then open the file for reading.
	// Thread-safe.
	Error openFile(ResourceFilename filename, ResourceFilePtr& file) const;

	// Return some sort of time a file was last updated. This time is opaque and it's increasing with every update. Only works for filesystem files
	U64 getFileUpdateTime(ResourceFilename filename) const;

	// Take the filename (which is relative) and return the full path of the file. Only works for filesystem files
	ResourceString getFileFullPath(ResourceFilename filename) const;

	// Iterate all the filenames from all paths provided.
	template<typename TFunc>
	void iterateAllFilenames(TFunc func) const
	{
		for(const Path& path : m_paths)
		{
			for(const FileInfo& file : path.m_files)
			{
				if(func(file.m_filename.toCString()) == FunctorContinue::kStop)
				{
					break;
				}
			}
		}
	}

	// Iterate paths in the DataPaths CVar
	template<typename TFunc>
	void iterateAllResourceBasePaths(TFunc func) const
	{
		for(const Path& path : m_paths)
		{
			const FunctorContinue cont = func(path.m_path);
			if(cont == FunctorContinue::kStop)
			{
				break;
			}
		}
	}

#if !ANKI_TESTS
private:
#endif
	class FileInfo
	{
	public:
		ResourceString m_filename;
		U64 m_filenameHash = 0;
	};

	class Path
	{
	public:
		ResourceDynamicArray<FileInfo> m_files; // Files inside the directory.
		ResourceString m_path; // A directory or an archive.
		Bool m_isArchive = false;
		Bool m_isSpecial = false;

		Path() = default;

		Path(const Path&) = delete; // Non-copyable

		Path(Path&& b)
		{
			*this = std::move(b);
		}

		Path& operator=(const Path&) = delete; // Non-copyable

		Path& operator=(Path&& b)
		{
			m_files = std::move(b.m_files);
			m_path = std::move(b.m_path);
			m_isArchive = b.m_isArchive;
			m_isSpecial = b.m_isSpecial;
			return *this;
		}
	};

	ResourceList<Path> m_paths;
	ResourceString m_cacheDir;

	// Add a filesystem path or an archive. The path is read-only.
	Error addNewPath(CString path, const ResourceStringList& includeStrings, const ResourceStringList& excludedStrings);

	Error openFileInternal(const ResourceFilename& filename, ResourceFile*& rfile) const;
};

} // end namespace anki