1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
|
local uv = vim.uv
local M = {}
--- @enum vim._watch.FileChangeType
--- Types of events watchers will emit.
M.FileChangeType = {
Created = 1,
Changed = 2,
Deleted = 3,
}
--- @class vim._watch.Opts
---
--- @field debounce? integer ms
---
--- An |lpeg| pattern. Only changes to files whose full paths match the pattern
--- will be reported. Only matches against non-directoriess, all directories will
--- be watched for new potentially-matching files. exclude_pattern can be used to
--- filter out directories. When nil, matches any file name.
--- @field include_pattern? vim.lpeg.Pattern
---
--- An |lpeg| pattern. Only changes to files and directories whose full path does
--- not match the pattern will be reported. Matches against both files and
--- directories. When nil, matches nothing.
--- @field exclude_pattern? vim.lpeg.Pattern
--- @alias vim._watch.Callback fun(path: string, change_type: vim._watch.FileChangeType)
--- @class vim._watch.watch.Opts : vim._watch.Opts
--- @field uvflags? uv.fs_event_start.flags
--- Decides if `path` should be skipped.
---
--- @param path string
--- @param opts? vim._watch.Opts
local function skip(path, opts)
if not opts then
return false
end
if opts.include_pattern and opts.include_pattern:match(path) == nil then
return true
end
if opts.exclude_pattern and opts.exclude_pattern:match(path) ~= nil then
return true
end
return false
end
--- Initializes and starts a |uv_fs_event_t|
---
--- @param path string The path to watch
--- @param opts vim._watch.watch.Opts? Additional options:
--- - uvflags (table|nil)
--- Same flags as accepted by |uv.fs_event_start()|
--- @param callback vim._watch.Callback Callback for new events
--- @return fun() cancel Stops the watcher
function M.watch(path, opts, callback)
vim.validate('path', path, 'string')
vim.validate('opts', opts, 'table', true)
vim.validate('callback', callback, 'function')
opts = opts or {}
path = vim.fs.normalize(path)
local uvflags = opts and opts.uvflags or {}
local handle = assert(uv.new_fs_event())
local _, start_err, start_errname = handle:start(path, uvflags, function(err, filename, events)
assert(not err, err)
local fullpath = path
if filename then
fullpath = vim.fs.normalize(vim.fs.joinpath(fullpath, filename))
end
if skip(fullpath, opts) then
return
end
--- @type vim._watch.FileChangeType
local change_type
if events.rename then
local _, staterr, staterrname = uv.fs_stat(fullpath)
if staterrname == 'ENOENT' then
change_type = M.FileChangeType.Deleted
else
assert(not staterr, staterr)
change_type = M.FileChangeType.Created
end
elseif events.change then
change_type = M.FileChangeType.Changed
end
callback(fullpath, change_type)
end)
if start_err then
if start_errname == 'ENOENT' then
-- Server may send "workspace/didChangeWatchedFiles" with nonexistent `baseUri` path.
-- This is mostly a placeholder until we have `nvim_log` API.
vim.notify_once(('watch.watch: %s'):format(start_err), vim.log.levels.INFO)
end
handle:close()
-- TODO(justinmk): log important errors once we have `nvim_log` API.
return function() end
end
return function()
local _, stop_err = handle:stop()
assert(not stop_err, stop_err)
local is_closing, close_err = handle:is_closing()
assert(not close_err, close_err)
if not is_closing then
handle:close()
end
end
end
--- Initializes and starts a |uv_fs_event_t| recursively watching every directory underneath the
--- directory at path.
---
--- @param path string The path to watch. Must refer to a directory.
--- @param opts vim._watch.Opts? Additional options
--- @param callback vim._watch.Callback Callback for new events
--- @return fun() cancel Stops the watcher
function M.watchdirs(path, opts, callback)
vim.validate('path', path, 'string')
vim.validate('opts', opts, 'table', true)
vim.validate('callback', callback, 'function')
opts = opts or {}
local debounce = opts.debounce or 500
---@type table<string, uv.uv_fs_event_t> handle by fullpath
local handles = {}
local timer = assert(uv.new_timer())
--- Map of file path to boolean indicating if the file has been changed
--- at some point within the debounce cycle.
--- @type table<string, boolean>
local filechanges = {}
local process_changes --- @type fun()
--- @param filepath string
--- @return uv.fs_event_start.callback
local function create_on_change(filepath)
return function(err, filename, events)
assert(not err, err)
local fullpath = vim.fs.joinpath(filepath, filename)
if skip(fullpath, opts) then
return
end
if not filechanges[fullpath] then
filechanges[fullpath] = events.change or false
end
timer:start(debounce, 0, process_changes)
end
end
process_changes = function()
-- Since the callback is debounced it may have also been deleted later on
-- so we always need to check the existence of the file:
-- stat succeeds, changed=true -> Changed
-- stat succeeds, changed=false -> Created
-- stat fails -> Removed
for fullpath, changed in pairs(filechanges) do
uv.fs_stat(fullpath, function(_, stat)
---@type vim._watch.FileChangeType
local change_type
if stat then
change_type = changed and M.FileChangeType.Changed or M.FileChangeType.Created
if stat.type == 'directory' then
local handle = handles[fullpath]
if not handle then
handle = assert(uv.new_fs_event())
handles[fullpath] = handle
handle:start(fullpath, {}, create_on_change(fullpath))
end
end
else
change_type = M.FileChangeType.Deleted
local handle = handles[fullpath]
if handle then
if not handle:is_closing() then
handle:close()
end
handles[fullpath] = nil
end
end
callback(fullpath, change_type)
end)
end
filechanges = {}
end
local root_handle = assert(uv.new_fs_event())
handles[path] = root_handle
local _, start_err, start_errname = root_handle:start(path, {}, create_on_change(path))
if start_err then
if start_errname == 'ENOENT' then
-- Server may send "workspace/didChangeWatchedFiles" with nonexistent `baseUri` path.
-- This is mostly a placeholder until we have `nvim_log` API.
vim.notify_once(('watch.watchdirs: %s'):format(start_err), vim.log.levels.INFO)
end
-- TODO(justinmk): log important errors once we have `nvim_log` API.
-- Continue. vim.fs.dir() will return nothing, so the code below is harmless.
end
--- "640K ought to be enough for anyone"
--- Who has folders this deep?
local max_depth = 100
for name, type in vim.fs.dir(path, { depth = max_depth }) do
if type == 'directory' then
local filepath = vim.fs.joinpath(path, name)
if not skip(filepath, opts) then
local handle = assert(uv.new_fs_event())
handles[filepath] = handle
handle:start(filepath, {}, create_on_change(filepath))
end
end
end
local function cancel()
for fullpath, handle in pairs(handles) do
if not handle:is_closing() then
handle:close()
end
handles[fullpath] = nil
end
timer:stop()
timer:close()
end
return cancel
end
--- @param data string
--- @param opts vim._watch.Opts?
--- @param callback vim._watch.Callback
local function on_inotifywait_output(data, opts, callback)
local d = vim.split(data, '%s+')
-- only consider the last reported event
local path, event, file = d[1], d[2], d[#d]
local fullpath = vim.fs.joinpath(path, file)
if skip(fullpath, opts) then
return
end
--- @type integer
local change_type
if event == 'CREATE' then
change_type = M.FileChangeType.Created
elseif event == 'DELETE' then
change_type = M.FileChangeType.Deleted
elseif event == 'MODIFY' then
change_type = M.FileChangeType.Changed
elseif event == 'MOVED_FROM' then
change_type = M.FileChangeType.Deleted
elseif event == 'MOVED_TO' then
change_type = M.FileChangeType.Created
end
if change_type then
callback(fullpath, change_type)
end
end
--- @param path string The path to watch. Must refer to a directory.
--- @param opts vim._watch.Opts?
--- @param callback vim._watch.Callback Callback for new events
--- @return fun() cancel Stops the watcher
function M.inotify(path, opts, callback)
local obj = vim.system({
'inotifywait',
'--quiet', -- suppress startup messages
'--no-dereference', -- don't follow symlinks
'--monitor', -- keep listening for events forever
'--recursive',
'--event',
'create',
'--event',
'delete',
'--event',
'modify',
'--event',
'move',
string.format('@%s/.git', path), -- ignore git directory
path,
}, {
stderr = function(err, data)
if err then
error(err)
end
if data and #vim.trim(data) > 0 then
vim.schedule(function()
if vim.fn.has('linux') == 1 and vim.startswith(data, 'Failed to watch') then
data = 'inotify(7) limit reached, see :h inotify-limitations for more info.'
end
vim.notify('inotify: ' .. data, vim.log.levels.ERROR)
end)
end
end,
stdout = function(err, data)
if err then
error(err)
end
for line in vim.gsplit(data or '', '\n', { plain = true, trimempty = true }) do
on_inotifywait_output(line, opts, callback)
end
end,
-- --latency is locale dependent but tostring() isn't and will always have '.' as decimal point.
env = { LC_NUMERIC = 'C' },
})
return function()
obj:kill(2)
end
end
return M
|