lua: Add app.fs object with some functions/properties for file names

src/app/CMakeLists.txt

@@ -149,6 +149,7 @@ if(ENABLE_SCRIPTING)
   set(scripting_files
     commands/cmd_run_script.cpp
     script/app_command_object.cpp
+    script/app_fs_object.cpp
     script/app_object.cpp
     script/brush_class.cpp
     script/cel_class.cpp

src/app/script/app_fs_object.cpp

@@ -0,0 +1,165 @@
+// Aseprite
+// Copyright (C) 2019  Igara Studio S.A.
+//
+// This program is distributed under the terms of
+// the End-User License Agreement for Aseprite.
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include "app/app.h"
+#include "app/resource_finder.h"
+#include "app/script/luacpp.h"
+#include "base/fs.h"
+
+namespace app {
+namespace script {
+
+namespace {
+
+struct AppFS { };
+
+int AppFS_pathSeparator(lua_State* L)
+{
+  const char sep[2] = { base::path_separator, 0 };
+  lua_pushstring(L, sep);
+  return 1;
+}
+
+template<std::string (*Func)(const std::string& path)>
+int AppFS_pathElement(lua_State* L)
+{
+  const char* fn = lua_tostring(L, 1);
+  if (fn)
+    lua_pushstring(L, Func(fn).c_str());
+  else
+    lua_pushnil(L);
+ return 1;
+}
+
+int AppFS_joinPath(lua_State* L)
+{
+  const char* fn = lua_tostring(L, 1);
+  if (!fn) {
+    lua_pushnil(L);
+    return 1;
+  }
+
+  std::string result(fn);
+  const int n = lua_gettop(L);
+  for (int i=2; i<=n; ++i) {
+    const char* part = lua_tostring(L, i);
+    if (part)
+      result = base::join_path(result, part);
+  }
+  lua_pushstring(L, result.c_str());
+ return 1;
+}
+
+template<std::string (*Func)()>
+int AppFS_get_specialPath(lua_State* L)
+{
+  lua_pushstring(L, Func().c_str());
+  return 1;
+}
+
+int AppFS_get_userConfigPath(lua_State* L)
+{
+  ResourceFinder rf(false);
+  rf.includeUserDir("");
+  std::string dir = rf.defaultFilename();
+  lua_pushstring(L, dir.c_str());
+  return 1;
+}
+
+int AppFS_isFile(lua_State* L)
+{
+  const char* fn = lua_tostring(L, 1);
+  if (fn)
+    lua_pushboolean(L, base::is_file(fn));
+  else
+    lua_pushboolean(L, false);
+ return 1;
+}
+
+int AppFS_isDirectory(lua_State* L)
+{
+  const char* fn = lua_tostring(L, 1);
+  if (fn)
+    lua_pushboolean(L, base::is_directory(fn));
+  else
+    lua_pushboolean(L, false);
+ return 1;
+}
+
+int AppFS_fileSize(lua_State* L)
+{
+  const char* fn = lua_tostring(L, 1);
+  if (fn)
+    lua_pushinteger(L, base::file_size(fn));
+  else
+    lua_pushnil(L);
+ return 1;
+}
+
+int AppFS_listFiles(lua_State* L)
+{
+  const char* path = lua_tostring(L, 1);
+  lua_newtable(L);
+  if (path) {
+    int i = 0;
+    for (auto fn : base::list_files(path)) {
+      lua_pushstring(L, fn.c_str());
+      lua_seti(L, -2, ++i);
+    }
+  }
+  return 1;
+}
+
+const Property AppFS_properties[] = {
+  { "pathSeparator", AppFS_pathSeparator, nullptr },
+  // Special folder names
+  { "currentPath", AppFS_get_specialPath<base::get_current_path>, nullptr },
+  { "appPath", AppFS_get_specialPath<base::get_app_path>, nullptr },
+  { "tempPath", AppFS_get_specialPath<base::get_temp_path>, nullptr },
+  { "userDocsPath", AppFS_get_specialPath<base::get_user_docs_folder>, nullptr },
+  { "userConfigPath", AppFS_get_userConfigPath, nullptr },
+  { nullptr, nullptr, nullptr }
+};
+
+const luaL_Reg AppFS_methods[] = {
+  // Path manipulation
+  { "filePath", AppFS_pathElement<base::get_file_path> },
+  { "fileName", AppFS_pathElement<base::get_file_name> },
+  { "fileExtension", AppFS_pathElement<base::get_file_extension> },
+  { "fileTitle", AppFS_pathElement<base::get_file_title> },
+  { "filePathAndTitle", AppFS_pathElement<base::get_file_title_with_path> },
+  { "normalizePath", AppFS_pathElement<base::normalize_path> },
+  { "joinPath", AppFS_joinPath },
+  // File system information
+  { "isFile", AppFS_isFile },
+  { "isDirectory", AppFS_isDirectory },
+  { "fileSize", AppFS_fileSize },
+  { "listFiles", AppFS_listFiles },
+  { nullptr, nullptr }
+};
+
+} // anonymous namespace
+
+DEF_MTNAME(AppFS);
+
+void register_app_fs_object(lua_State* L)
+{
+  REG_CLASS(L, AppFS);
+  REG_CLASS_PROPERTIES(L, AppFS);
+
+  lua_getglobal(L, "app");
+  lua_pushstring(L, "fs");
+  push_new<AppFS>(L);
+  lua_rawset(L, -3);
+  lua_pop(L, 1);
+}
+
+} // namespace script
+} // namespace app

src/app/script/engine.cpp

@@ -135,6 +135,7 @@ int unsupported(lua_State* L)
 
 void register_app_object(lua_State* L);
 void register_app_pixel_color_object(lua_State* L);
+void register_app_fs_object(lua_State* L);
 void register_app_command_object(lua_State* L);
 void register_app_preferences_object(lua_State* L);
 
@@ -232,6 +233,7 @@ Engine::Engine()
   // Register global app object
   register_app_object(L);
   register_app_pixel_color_object(L);
+  register_app_fs_object(L);
   register_app_command_object(L);
   register_app_preferences_object(L);