Final API change for FileSystem. Remove the root enum and replace usi…

…ng uri scheema.

The interenal implemenations still needs a little work, also, can we avoid reading the filesystem *every* frame when showing the load files dialog?  Would be nice.

data/meta/Constants.lua

@@ -64,9 +64,6 @@
 -- A <Constants.DetailLevel> string
 ---@class DetailLevel: string
 
--- A <Constants.FileSystemRoot> string
----@class FileSystemRoot: string
-
 -- A <Constants.PiGuiFaceFlags> string
 ---@class PiGuiFaceFlags: string
 
@@ -147,9 +144,6 @@ Constants.BodySuperType = {}
 ---@type DetailLevel[]
 Constants.DetailLevel = {}
 
----@type FileSystemRoot[]
-Constants.FileSystemRoot = {}
-
 ---@type PiGuiFaceFlags[]
 Constants.PiGuiFaceFlags = {}
 

data/meta/FileSystem.lua

@@ -9,13 +9,13 @@
 ---@class FileSystem
 local FileSystem = {}
 
----@param root string A FileSystemRoot constant. Can be either "DATA" or "USER"
+---@param path string The directory to read the contents of.
 ---@return string[] files  A list of files as full paths from the root
 ---@return string[] dirs   A list of dirs as full paths from the root
 ---
 --- Example:
----  > local files, dirs = FileSystem.ReadDirectory(root, path)
-function FileSystem.ReadDirectory(root, path) end
+---  > local files, dirs = FileSystem.ReadDirectory("user://savefiles")
+function FileSystem.ReadDirectory(path) end
 
 --- Join the passed arguments into a path, correctly handling separators and .
 --- and .. special dirs.

data/modules/AutoSave/AutoSave.lua

@@ -6,7 +6,7 @@ local FileSystem = require 'FileSystem'
 local max_autosaves = 9
 
 local function PickNextAutosave()
-	local ok, files, _ = pcall(FileSystem.ReadDirectory, 'USER', 'savefiles')
+	local ok, files, _ = pcall(FileSystem.ReadDirectory, 'user://savefiles')
 	if not ok then
 		print('Error picking auto-save')
 		return '_autosave1'

data/pigui/modules/saveloadgame.lua

@@ -105,7 +105,8 @@ local function displaySave(f)
 end
 
 local function showSaveFiles()
-	local ok, files, _ = pcall(FileSystem.ReadDirectory, "USER","savefiles")
+	-- TODO: This is reading the files of disc every frame, think about refactoring to not do this.
+	local ok, files, _ = pcall(FileSystem.ReadDirectory, "user://savefiles")
 	if not ok then
 		print('Error: ' .. files)
 		saveFileCache = {}

src/enum_table.cpp

@@ -238,12 +238,6 @@ const struct EnumItem ENUM_DetailLevel[] = {
 	{ 0, 0 },
 };
 
-const struct EnumItem ENUM_FileSystemRoot[] = {
-	{ "USER", int(LuaFileSystem::ROOT_USER) },
-	{ "DATA", int(LuaFileSystem::ROOT_DATA) },
-	{ 0, 0 },
-};
-
 const struct EnumItem ENUM_PiGuiFaceFlags[] = {
 	{ "RAND", int(PiGui::Face::RAND) },
 	{ "MALE", int(PiGui::Face::MALE) },
@@ -325,7 +319,6 @@ const struct EnumTable ENUM_TABLES[] = {
 	{ "BodyType", ENUM_BodyType },
 	{ "BodySuperType", ENUM_BodySuperType },
 	{ "DetailLevel", ENUM_DetailLevel },
-	{ "FileSystemRoot", ENUM_FileSystemRoot },
 	{ "PiGuiFaceFlags", ENUM_PiGuiFaceFlags },
 	{ "ModelDebugFlags", ENUM_ModelDebugFlags },
 	{ "CruiseDirection", ENUM_CruiseDirection },
@@ -355,7 +348,6 @@ const struct EnumTable ENUM_TABLES_PUBLIC[] = {
 	{ "BodyType", ENUM_BodyType },
 	{ "BodySuperType", ENUM_BodySuperType },
 	{ "DetailLevel", ENUM_DetailLevel },
-	{ "FileSystemRoot", ENUM_FileSystemRoot },
 	{ "PiGuiFaceFlags", ENUM_PiGuiFaceFlags },
 	{ "ModelDebugFlags", ENUM_ModelDebugFlags },
 	{ "CruiseDirection", ENUM_CruiseDirection },

src/enum_table.h

@@ -34,7 +34,6 @@ extern const struct EnumItem ENUM_PolitGovType[];
 extern const struct EnumItem ENUM_BodyType[];
 extern const struct EnumItem ENUM_BodySuperType[];
 extern const struct EnumItem ENUM_DetailLevel[];
-extern const struct EnumItem ENUM_FileSystemRoot[];
 extern const struct EnumItem ENUM_PiGuiFaceFlags[];
 extern const struct EnumItem ENUM_ModelDebugFlags[];
 extern const struct EnumItem ENUM_CruiseDirection[];

src/lua/LuaFileSystem.cpp

@@ -113,33 +113,6 @@ int LuaFileSystem::l_patched_io_open(lua_State* L)
 
 	return rv;
 }
-/*
- * Interface: FileSystem
- *
- * A global table that provides access to the filesystem.
- *
- * This interface is protected. It can only be used by scripts in Pioneer's
- * data directory. Mods and scripts in the user directory that try to use it
- * will get a Lua error.
- */
-
-FileSystem::FileSource* get_filesytem_for_root(LuaFileSystem::Root root)
-{
-	FileSystem::FileSource *fs = nullptr;
-	switch (root) {
-	case LuaFileSystem::ROOT_USER:
-		fs = &FileSystem::userFiles;
-		break;
-
-	case LuaFileSystem::ROOT_DATA:
-		fs = &FileSystem::gameDataFiles;
-		break;
-
-	default:
-		assert(0); // can't happen
-	}
-	return fs;
-}
 
 static void push_date_time(lua_State *l, const Time::DateTime &dt)
 {
@@ -160,13 +133,12 @@ static void push_date_time(lua_State *l, const Time::DateTime &dt)
 /*
  * Function: ReadDirectory
  *
- * > local files, dirs = FileSystem.ReadDirectory(root, path)
+ * > local files, dirs = FileSystem.ReadDirectory(path)
  *
  * Return a list of files and dirs in the specified directory.
  *
  * Parameters:
  *
- *   root - a <FileSystemRoot> constant for the root of the dir to read from
  *   path - optional. a directory under the root
  *
  * Returns:
@@ -184,30 +156,27 @@ static void push_date_time(lua_State *l, const Time::DateTime &dt)
  */
 static int l_filesystem_read_dir(lua_State *l)
 {
-	LuaFileSystem::Root root = static_cast<LuaFileSystem::Root>(LuaConstants::GetConstantFromArg(l, "FileSystemRoot", 1));
-	std::string path;
-	if (lua_gettop(l) > 1)
-		path = luaL_checkstring(l, 2);
-
-	FileSystem::FileSource* fs = get_filesytem_for_root(root);
+	const char* path_str = luaL_checkstring(l, 1);
+	ParsedFilePath path = ParsedFilePath(l, path_str);
 
-	assert(fs);
+	// shame these methods can't take a string_view.
+	std::string rel_path = std::string(path.GetRelativePath());
 
 	{
 		try {
-			const FileSystem::FileInfo &info = fs->Lookup(path);
+			FileSystem::FileInfo info = path.GetFileSource().Lookup(rel_path);
 			if (!info.IsDir()) {
-				luaL_error(l, "'%s' is not a directory", path.c_str());
+				luaL_error(l, "'%s' is not a directory", path_str);
 				return 0;
 			}
 		} catch (const std::invalid_argument &) {
-			luaL_error(l, "'%s' is not a valid path", path.c_str());
+			luaL_error(l, "'%s' is not a valid path", path_str);
 			return 0;
 		}
 	}
 
-	FileSystem::FileEnumerator files(*fs, FileSystem::FileEnumerator::IncludeDirs);
-	files.AddSearchRoot(path);
+	FileSystem::FileEnumerator files(path.GetFileSource(), FileSystem::FileEnumerator::IncludeDirs);
+	files.AddSearchRoot(rel_path);
 
 	lua_newtable(l);
 	int filesTable = lua_gettop(l);
@@ -223,9 +192,9 @@ static int l_filesystem_read_dir(lua_State *l)
 		lua_setfield(l, -2, "mtime");
 
 		if (info.IsDir())
-			lua_rawseti(l, dirsTable, lua_rawlen(l, dirsTable) + 1);
+			lua_rawseti(l, dirsTable, (int)lua_rawlen(l, dirsTable) + 1);
 		else
-			lua_rawseti(l, filesTable, lua_rawlen(l, filesTable) + 1);
+			lua_rawseti(l, filesTable, (int)lua_rawlen(l, filesTable) + 1);
 	}
 
 	return 2;

src/lua/LuaFileSystem.h

@@ -12,11 +12,6 @@ typedef int (*lua_CFunction) (lua_State* L);
 namespace LuaFileSystem {
 	void Register();
 
-	enum Root { // <enum scope='LuaFileSystem' name=FileSystemRoot prefix=ROOT_ public>
-		ROOT_USER,
-		ROOT_DATA
-	};
-
 	void register_raw_io_open_function(lua_CFunction open);
 	int l_patched_io_open(lua_State* L);
 } // namespace LuaFileSystem