Metadata

stuart6854 · Dec 5, 2023 · 4b6dded · 4b6dded
1 parent 5c36d4d
commit 4b6dded
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 8 deletions.
diff --git a/include/gfs/file_importer.hpp b/include/gfs/file_importer.hpp
@@ -11,7 +11,11 @@ namespace gfs
 	public:
 		virtual ~FileImporter() = default;
 
-		virtual bool Import(Filesystem& fs, const std::filesystem::path& importFilename, MountID outputMount, const std::filesystem::path& outputDir) = 0;
+		virtual bool Import(Filesystem& fs,
+			const std::filesystem::path& importFilename,
+			MountID outputMount,
+			const std::filesystem::path& outputDir,
+			const std::string& metadata) = 0;
 		virtual bool Reimport(Filesystem& fs, const Filesystem::File& file) = 0;
 	};
 

diff --git a/include/gfs/filesystem.hpp b/include/gfs/filesystem.hpp
@@ -106,6 +106,7 @@ namespace gfs
 			MountID MountId;					  // The Id of the mount this file is in.
 			std::filesystem::path MountRelPath;	  // Path to this file relative to the mount it is in.
 			std::filesystem::path SourceFilename; // The source file this file was imported from.
+			std::string MetadataStr;			  // String containg optional metadata eg. Import settings, etc.
 			std::vector<FileID> FileDependencies; // Files this file references.
 			uint32_t UncompressedSize;
 			uint32_t CompressedSize;
@@ -142,7 +143,8 @@ namespace gfs
 			const std::vector<FileID>& fileDependencies,
 			const BinaryStreamable& dataObject,
 			bool compress,
-			const std::filesystem::path& sourceFilename = "");
+			const std::filesystem::path& sourceFilename = "",
+			const std::string& metadata = "");
 
 		/**
 		 * @brief
@@ -176,7 +178,7 @@ namespace gfs
 		 */
 		auto GetImporter(const std::string& fileExt) -> std::shared_ptr<FileImporter>;
 
-		bool Import(const std::filesystem::path& filename, MountID outputMount, const std::filesystem::path& outputDir);
+		bool Import(const std::filesystem::path& filename, MountID outputMount, const std::filesystem::path& outputDir, const std::string& metadata = "");
 
 		bool Reimport(FileID fileId);
 

diff --git a/src/gfs/filesystem.cpp b/src/gfs/filesystem.cpp
@@ -106,7 +106,8 @@ namespace gfs
 		const std::vector<FileID>& fileDependencies,
 		const BinaryStreamable& dataObject,
 		bool compress,
-		const std::filesystem::path& sourceFilename)
+		const std::filesystem::path& sourceFilename,
+		const std::string& metadata)
 	{
 		auto* mount = GetMount(mountId);
 		if (!mount)
@@ -142,6 +143,7 @@ namespace gfs
 		file.MountId = mountId;
 		file.MountRelPath = filename;
 		file.SourceFilename = sourceFilename;
+		file.MetadataStr = metadata;
 		file.FileDependencies = fileDependencies;
 		file.UncompressedSize = uint32_t(uncompressedDataBuffer.GetSize());
 		file.CompressedSize = uint32_t(compressedDataBuffer.GetSize());
@@ -312,17 +314,17 @@ namespace gfs
 		return it->second;
 	}
 
-	bool Filesystem::Import(const std::filesystem::path& filename, MountID outputMount, const std::filesystem::path& outputDir)
+	bool Filesystem::Import(const std::filesystem::path& filename, MountID outputMount, const std::filesystem::path& outputDir, const std::string& metadata)
 	{
 		if (filename.empty() || !std::filesystem::exists(filename) || !std::filesystem::is_regular_file(filename))
 			return false;
 
 		const auto fileExt = filename.extension().string();
-		auto importer = GetImporter(fileExt);
+		const auto importer = GetImporter(fileExt);
 		if (!importer)
 			return false;
 
-		return importer->Import(*this, filename, outputMount, outputDir);
+		return importer->Import(*this, filename, outputMount, outputDir, metadata);
 	}
 
 	bool Filesystem::Reimport(FileID fileId)
@@ -523,6 +525,11 @@ namespace gfs
 		pathStr = file.SourceFilename.string();
 		stream.write(reinterpret_cast<const char*>(pathStr.data()), strLen);
 
+		// Metadata
+		strLen = file.MetadataStr.size();
+		stream.write(reinterpret_cast<const char*>(&strLen), sizeof(strLen));
+		stream.write(reinterpret_cast<const char*>(file.MetadataStr.data()), strLen);
+
 		// File dependencies
 		const auto count = uint16_t(file.FileDependencies.size());
 		stream.write(reinterpret_cast<const char*>(&count), sizeof(count));
@@ -553,6 +560,13 @@ namespace gfs
 		stream.read(reinterpret_cast<char*>(pathStr.data()), strLen);
 		file.SourceFilename = pathStr;
 
+		// Source filename
+		strLen = 0;
+		stream.read(reinterpret_cast<char*>(&strLen), sizeof(strLen));
+		pathStr = std::string(strLen, 0);
+		stream.read(reinterpret_cast<char*>(pathStr.data()), strLen);
+		file.MetadataStr = pathStr;
+
 		// File dependencies
 		uint16_t count = 0;
 		stream.read(reinterpret_cast<char*>(&count), sizeof(count));

diff --git a/testbed/testbed.cpp b/testbed/testbed.cpp
@@ -60,7 +60,11 @@ struct TextResource : gfs::BinaryStreamable
 
 struct TextFileImporter : gfs::FileImporter
 {
-	bool Import(gfs::Filesystem& fs, const std::filesystem::path& importFilename, gfs::MountID outputMount, const std::filesystem::path& outputDir) override
+	bool Import(gfs::Filesystem& fs,
+		const std::filesystem::path& importFilename,
+		gfs::MountID outputMount,
+		const std::filesystem::path& outputDir,
+		const std::string& metadata) override
 	{
 		auto text = ReadTextFile(importFilename);
 		if (text.empty())