akkartik/wardley.love - Change D6DV2L5CX6YGDXHI3SQKYEOBNTKUOBB6M5OJTPSECRQJHRIAGSYAC

cleaner API for file-system access

Thanks to physfs and nativefs.lua

nativefs still introduces some inconsistencies with love.filesystem with relative paths:

love.fs.read: reads from save dir if it exists, falls back to source dir if not
nativefs.read: reads from save dir if it exists, falls back to source dir if not ✓
love.fs.write: always writes to save dir
nativefs.write: always writes to source dir (since no restrictions)
love.fs.newFile followed by file:open('r'): reads from save dir if it exists, source dir if not
nativefs.newFile followed by file:open('r'): always reads from working dir
love.fs.newFile followed by file:open('w'): always writes to save dir
nativefs.newFile followed by file:open('w'): always writes to working dir

So avoid using relative paths with App primitives.

Created by akkartik on August 30, 2023

D6DV2L5CX6YGDXHI3SQKYEOBNTKUOBB6M5OJTPSECRQJHRIAGSYAC

Dependencies

In channels

main

Change contents

Insertion in source_file.lua at line 13 [3.150241]

[3.150511]

-- the source editor supports only files in the save dir, not even subdirectories

Replacement in source_file.lua at line 15 [3.150241]

B:BD[3.150542] → [3.150542:150596]

  local infile = App.open_for_reading(State.filename)

[3.150542]

[3.150596]

  local infile = App.open_for_reading(App.save_dir..State.filename)

Replacement in source_file.lua at line 41 [3.150241]

B:BD[3.151341] → [3.151341:151396]

  local outfile = App.open_for_writing(State.filename)

[3.151341]

[3.151396]

  local outfile = App.open_for_writing(App.save_dir..State.filename)

Replacement in reference.md at line 361 [4.17]

B:BD[4.10826] → [4.10826:11154]

* `love.filesystem.getDirectoryItems(dir)` -- returns an unsorted array of the
  files and directories available under `dir`. `dir` must be relative to
  [LÖVE's save directory](https://love2d.org/wiki/love.filesystem.getSaveDirectory).
  There is no easy, portable way in Lua/LÖVE to list directories outside the
  save dir.

[4.10826]

[4.11154]

* `App.files(dir)` -- returns an unsorted array of the files and directories
  available under `dir`.

Deletion in reference.md at line 367 [4.17]

B:BD[4.11382] → [4.11382:11499]

  `filename` must be relative to [LÖVE's save directory](https://love2d.org/wiki/love.filesystem.getSaveDirectory).

Insertion in app.lua at line 100 [7.2]

[5.2328]

[6.7672]

  App.source_dir = ''
  App.current_dir = ''
  App.save_dir = ''

Replacement in app.lua at line 263 [7.2]

B:BD[8.4121] → [8.4121:4698]

  if Current_app == nil or Current_app == 'run' then
    return {
      write = function(self, ...)
                local args = {...}
                for i,s in ipairs(args) do
                  App.filesystem[filename] = App.filesystem[filename]..s
                end
              end,
      close = function(self)
              end,
    }
  elseif Current_app == 'source' then
    return {
      write = function(self, s)
                App.filesystem[filename] = App.filesystem[filename]..s
              end,
      close = function(self)
              end,
    }
  end

[8.4121]

[8.4698]

  return {
    write = function(self, s)
              App.filesystem[filename] = App.filesystem[filename]..s
            end,
    close = function(self)
            end,
  }

Insertion in app.lua at line 349 [7.2]
[9.61193]
[10.7569]
```
nativefs = require 'nativefs'
```

Replacement in app.lua at line 386 [7.2]

∅:D[11.1586] → [12.31:624]

B:BD[10.8162] → [12.31:624]

  if Current_app == nil or Current_app == 'run' then
    App.open_for_reading = function(filename) return io.open(filename, 'r') end
    App.open_for_writing = function(filename) return io.open(filename, 'w') end
  elseif Current_app == 'source' then
    -- HACK: source editor requires a couple of different foundational definitions
    App.open_for_reading =
        function(filename)
          local result = love.filesystem.newFile(filename)
          local ok, err = result:open('r')
          if ok then
            return result
          else
            return ok, err
          end

[10.8029]

[12.624]

  App.open_for_reading =
      function(filename)
        local result = nativefs.newFile(filename)
        local ok, err = result:open('r')
        if ok then
          return result
        else
          return ok, err

Replacement in app.lua at line 395 [7.2]

B:BD[12.636] → [12.636:895]

    App.open_for_writing =
        function(filename)
          local result = love.filesystem.newFile(filename)
          local ok, err = result:open('w')
          if ok then
            return result
          else
            return ok, err
          end

[12.636]

[12.895]

      end
  App.open_for_writing =
      function(filename)
        local result = nativefs.newFile(filename)
        local ok, err = result:open('w')
        if ok then
          return result
        else
          return ok, err

Replacement in app.lua at line 405 [7.2]

B:BD[12.907] → [12.907:913]

end

[12.907]

[2.845]

      end
  App.files = nativefs.getDirectoryItems
  App.source_dir = love.filesystem.getSource()..'/'
  App.current_dir = nativefs.getWorkingDirectory()..'/'
  App.save_dir = love.filesystem.getSaveDirectory()..'/'