Merge pull request #127 from CogentRedTester/API/v1.8.0

Update API to v1.8.0 and improve favourites.lua keybind handling

Author: CogentRedTester

addons/favourites.lua

@@ -22,7 +22,7 @@ local favourites_loaded = false
 
 ---@type ParserConfig
 local favs = {
-    api_version = "1.4.0",
+    api_version = "1.8.0",
     priority = 30,
     cursor = 1
 }
@@ -123,16 +123,14 @@ local function get_favourite(path)
 end
 
 --update the browser with new contents of the file
+---@async
 local function update_browser()
-    if fb.get_directory():find("[fF]avourites/") then
-        if fb.get_directory():find("[fF]avourites/$") then
-            local cursor = fb.get_selected_index()
-            fb.rescan()
-            fb.set_selected_index(cursor)
-            fb.redraw()
-        else
-            fb.clear_cache()
-        end
+    if favs.get_directory():find("^[fF]avourites/$") then
+        local cursor = favs.get_selected_index()
+        fb.rescan_await()
+        fb.set_selected_index(cursor)
+    else
+        fb.clear_cache({'favourites/', 'Favourites/'})
     end
 end
 
@@ -171,6 +169,7 @@ local function move_favourite(path, direction)
     write_to_file()
 end
 
+---@async
 local function toggle_favourite(cmd, state, co)
     local path = fb.get_full_path(state.list[state.selected], state.directory)
 
@@ -179,6 +178,7 @@ local function toggle_favourite(cmd, state, co)
     update_browser()
 end
 
+---@async
 local function move_key(cmd, state, co)
     if not state.directory:find("[fF]avourites/") then return false end
     local path = fb.get_full_path(state.list[state.selected], state.directory)
@@ -195,10 +195,6 @@ local function move_key(cmd, state, co)
 end
 
 update_favourites()
-mp.register_script_message("favourites/add_favourite", add_favourite)
-mp.register_script_message("favourites/remove_favourite", remove_favourite)
-mp.register_script_message("favourites/move_up", function(path) move_favourite(path, -1) end)
-mp.register_script_message("favourites/move_down", function(path) move_favourite(path, 1) end)
 
 favs.keybinds = {
     { "F", "toggle_favourite", toggle_favourite, {}, },

docs/addons.md

@@ -1,4 +1,4 @@
-# How to Write an Addon - API v1.7.1
+# How to Write an Addon - API v1.8.0
 
 Addons provide ways for file-browser to parse non-native directory structures. This document describes how one can create their own custom addon.
 
@@ -550,10 +550,12 @@ that were removed.
 
 ### Advanced Functions
 
-#### `fb.clear_cache(): void`
+#### `fb.clear_cache(directories?: string[]): void`
 
 Clears the directory cache. Use this if you are modifying the contents of directories other
 than the current one to ensure that their contents will be rescanned when next opened.
+An an array of directory strings is passed to the function only those directories
+will be cleared from the cache.
 
 #### `fb.coroutine.assert(err?: string): coroutine`
 
@@ -646,10 +648,15 @@ any additional arguments. The (not yet started) coroutine is returned by the fun
 
 #### `fb.rescan(): coroutine`
 
-Rescans the current directory. Equivalent to Ctrl+r without the cache refresh for higher level directories.
+Rescans the current directory. Equivalent to Ctrl+r without the cache refresh for any other directory.
 Returns the coroutine of the upcoming parse operation. The parse is queued and run when the script thread next goes idle,
 allowing one to store this value and use it to identify the triggered parse operation.
 
+#### `fb.rescan_await(): coroutine`
+
+Same as `fb.rescan()`, but if called from within a coroutine then the function will not
+return until the scan operation is complete.
+
 #### `fb.redraw(): void`
 
 Forces a redraw of the browser UI.

modules/apis/fb.lua

@@ -26,8 +26,17 @@ function fb.rescan()
     return scanning.rescan()
 end
 
-function fb.clear_cache()
-    cache:clear()
+---@async
+---@return thread
+function fb.rescan_await()
+    cache:clear({g.state.directory})
+    local co = scanning.rescan(nil, fb_utils.coroutine.callback())
+    coroutine.yield()
+    return co
+end
+
+function fb.clear_cache(directories)
+    cache:clear(directories)
 end
 
 ---A wrapper around scan_directory for addon API.

modules/globals.lua

@@ -10,7 +10,7 @@ local o = require 'modules.options'
 local globals = {}
 
 --sets the version for the file-browser API
-globals.API_VERSION = "1.7.1"
+globals.API_VERSION = "1.8.0"
 
 ---gets the current platform (only works in mpv v0.36+)
 ---@type string?

modules/navigation/scanning.lua

@@ -169,8 +169,9 @@ end
 
 ---rescans the folder and updates the list.
 ---@param moving_adjacent? number|boolean
+---@param cb? function
 ---@return thread # The coroutine for the triggered parse operation. May be aborted early if directory is in the cache.
-local function rescan(moving_adjacent)
+local function rescan(moving_adjacent, cb)
     if moving_adjacent == nil then moving_adjacent = 0 end
 
     --we can only make assumptions about the directory label when moving from adjacent directories
@@ -194,6 +195,7 @@ local function rescan(moving_adjacent)
         if not cache.traversal_stack[1] then cache:push() end
 
         ass.update_ass()
+        if cb then fb_utils.coroutine.run(cb) end
     end)
 
     g.state.co = co